@killb/sdk
TypeScript icon, indicating that this package has built-in type declarations

2.4.0 • Public • Published

KillB SDK

Welcome to the KillB SDK! This is an open-source project designed to facilitate and decrease the integration time with the KillB API. KillB is a fintech that provides ramp infrastructure and savings account services.

Installation

This project uses npm for package management. To install the project:

npm install @killb/sdk

Quickstart

Here's a quick guide on how to use the SDK:

import { Client, Config } from './src/client';

const config: Config = {
  testEnv: true, // Optional. Default is false.
  credentials: {
    apiKey: 'your-api-key',
    email: 'your-email',
    password: 'your-password',
  }
};

const client = new Client(config);

const users = await client.users.create({ ... });
const accounts = client.accounts;
// etc.

API Overview

This project provides the following services:
Users: Provides access to user-related operations. Accounts: Provides access to account-related operations. Quotation: Provides access to quotation-related operations. Ramps: Provides access to ramp-related operations. Webhook: Provides access to webhook-related operations. Savings: Provides access to savings-related operations. Each service is instantiated with the same configuration object, which is passed to the Client constructor.

API Reference

Feel free to take a look at our API docs. You can find them here.

Contributing

Contributions are welcome.

License

This project is open source and available under the MIT License.

Readme

Keywords

Package Sidebar

Install

npm i @killb/sdk

Weekly Downloads

16

Version

2.4.0

License

MIT

Unpacked Size

442 kB

Total Files

105

Last publish

Collaborators

  • renan.s