Client | Crypto Bot API

Main class for work with API for browsers

Library for browsers default export this class

Hierarchy

Store
- Client
  - ClientEmitter

Index

Methods

Constructors

constructor

Properties

Methods

call

call(method: string, options?: object): Promise<any>

- Defined in src/classes/Client.ts:215
Call backend API method directly (types unsafe)

Use it if backend API update (add new methods, change request or response fileds), but library is not

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- method: string
  
  Backend API method name
- options: object = {}
  
  Backend API options object
Returns Promise<any>
Promise, what resolved to backend API response result field value

createInvoice

createInvoice(options: CreateInvoiceOptions): Promise<Invoice>

- Defined in src/classes/Client.ts:153
Create invoice

Use toInvoice backend API result convert function and prepare backend API parameters prepareCreateInvoiceOptions function

throws
Error - If there is an error sending request to backend API, parsing response error or options object is invalid

Parameters
- options: CreateInvoiceOptions
  
  New invoice options
Returns Promise<Invoice>
Promise, what resolved to created invoice information object

getBalance

getBalance(currencyCode: string, isReturnInNanos?: boolean, isForce?: boolean): Promise<string>

- Defined in src/classes/Client.ts:84
Get API app balance value for passed currency

Call Client.getBalances method to fetch balances information

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- currencyCode: string
  
  Currency code
- isReturnInNanos: boolean = false
  
  If true, return raw balances in nanos, else return converted to coins balances
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<string>
Promise, what resolved to API app balance value for passed currency

getBalances

getBalances(isReturnInNanos?: boolean, isForce?: boolean): Promise<Balances>

- Defined in src/classes/Client.ts:62
Get API app balances infomation

Use toBalances backend API result convert function

Call Store.getCurrencies method to fetch exchange rates information

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- isReturnInNanos: boolean = false
  
  If true, return raw balances in nanos, else return converted to coins balances
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Balances>
Promise, what resolved to API app balances infomation object

getCurrencies

getCurrencies(isForce?: boolean): Promise<Currencies>

Inherited from Store.getCurrencies
- Defined in src/classes/Store.ts:127
Get API supported currencies infomation

Use toCurrencies backend API result convert function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- Optional isForce: boolean
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Currencies>
Promise, what resolved to API supported currencies infomation object

getCurrency

getCurrency(currencyCode: string, isForce?: boolean): Promise<Currency>

- Defined in src/classes/Client.ts:107
Get currency with passed code infomation

Call Store.getCurrencies method to fetch currencies information

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- currencyCode: string
  
  Currency code
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Currency>
Promise, what resolved to currency with passed code infomation object or null, if currency with passed code not exists

getExchangeRate

getExchangeRate(source: string, target: string, isForce?: boolean): Promise<number>

- Defined in src/classes/Client.ts:130
Get one exchange rate infomation to passed currencies pair

Call Store.getExchangeRates method to fetch exchange rates information, Store.getCurrencies method to fetch currencies information and use getExchageRate function to get signle exchange rate

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- source: string
  
  Source currency code
- target: string
  
  Target currency code
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<number>
Promise, what resolved to exchange rate or zero, if currencies pair not exists

getExchangeRates

getExchangeRates(isForce?: boolean): Promise<ExchangeRates>

Inherited from Store.getExchangeRates
- Defined in src/classes/Store.ts:147
Get API supported currencies exchange rate infomation

Use toExchangeRates backend API result convert function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- Optional isForce: boolean
  
  If true, return fresh data from backend API, not from cache
Returns Promise<ExchangeRates>
Promise, what resolved to API supported currencies exchange rate infomation object

getInvoices

getInvoices(options?: GetInvoicesOptions): Promise<Invoices>

- Defined in src/classes/Client.ts:170
Get invoices

Use toInvoices backend API result convert function and prepare backend API parameters prepareGetInvoicesOptions function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- options: GetInvoicesOptions = {}
  
  Filters options
Returns Promise<Invoices>
Promise, what resolved to invoices information object

getInvoicesPaginate

getInvoicesPaginate(options?: GetInvoicesPaginateOptions): Promise<InvoicesPaginated>

- Defined in src/classes/Client.ts:192
Get invoices paginated

Fetch invoices with page options parameter, except count and offset

See Client.getPageSize and Client.setPageSize

Use toInvoicesPaginated backend API result convert function and prepare backend API parameters prepareGetInvoicesPaginateOptions function

throws
Error - If there is an error sending request to backend API, parsing response error or options object is invalid

Parameters
- options: GetInvoicesPaginateOptions = {}
  
  Filters options
Returns Promise<InvoicesPaginated>
Promise, what resolved to invoices information object

getMe

getMe(isForce?: boolean): Promise<Me>

Inherited from Store.getMe
- Defined in src/classes/Store.ts:167
Get associated with passed API key app infomation

Use toMe backend API result convert function

throws
Error - If there is an error sending request to backend API or parsing response

Parameters
- isForce: boolean = false
  
  If true, return fresh data from backend API, not from cache
Returns Promise<Me>
Promise, what resolved to associated with passed API key app infomation object

getPageSize

getPageSize(): number

- Defined in src/classes/Client.ts:28
Return count invoices per page for Client.getInvoicesPaginate method

Returns number

setPageSize

setPageSize(pageSizeParam: number): void

- Defined in src/classes/Client.ts:39
Set count invoices per page for Client.getInvoicesPaginate method

throws
Error - If pageSize parameter is invalid

Parameters
- pageSizeParam: number
Returns void

Constructors

constructor

new Client(apiKey: string, endpoint?: string): Client

Inherited from Store.constructor
- Defined in src/classes/Store.ts:112
Create class instance

throws
Error - If passed invalid API key or endpoint

Parameters
- apiKey: string
  
  Crypto Bot API key, looks like '1234:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
- endpoint: string = 'mainnet'
  
  API endpoint url or 'mainnet' or 'testnet' for hardcoded in library endpoint urls
Returns Client

Properties

Protected _transport

_transport: Transport

Transport class instance

Private _pageSize

_pageSize: number = 100

Page size for Client.getInvoicesPaginate method

Hierarchy

Index

Methods

Constructors

Properties

Methods

call

Parameters

method: string

options: object = {}

Returns Promise<any>

createInvoice

Parameters

options: CreateInvoiceOptions

Returns Promise<Invoice>

getBalance

Parameters

currencyCode: string

isReturnInNanos: boolean = false

isForce: boolean = false

Returns Promise<string>

getBalances

Parameters

isReturnInNanos: boolean = false

isForce: boolean = false

Returns Promise<Balances>

getCurrencies

Parameters

Optional isForce: boolean

Returns Promise<Currencies>

getCurrency

Parameters

currencyCode: string

isForce: boolean = false

Returns Promise<Currency>

getExchangeRate

Parameters

source: string

target: string

isForce: boolean = false

Returns Promise<number>

getExchangeRates

Parameters

Optional isForce: boolean

Returns Promise<ExchangeRates>

getInvoices

Parameters

options: GetInvoicesOptions = {}

Returns Promise<Invoices>

getInvoicesPaginate

Parameters

options: GetInvoicesPaginateOptions = {}

Returns Promise<InvoicesPaginated>

getMe

Parameters

isForce: boolean = false

Returns Promise<Me>

getPageSize

Returns number

setPageSize

Parameters

pageSizeParam: number

Returns void

Constructors

constructor

Parameters

apiKey: string

endpoint: string = 'mainnet'

Returns Client

Properties

Protected _transport

Private _pageSize