API | bitkub

Hierarchy

API

Indexable

[key: string]: any

Index

Constructors

constructor

Properties

_server_url

Methods

Object literals

_credentials

Constructors

constructor

new API(options: object): API

- Defined in api/index.ts:26
API class for Bitkub API

Parameters
- options: object
  
  An options for Bitkub API authentication
  - api_key: string
    
    An api key generated from Bitkub
  - api_secret: string
    
    A api secret generated from Bitkub
  - Optional server_url?: undefined | string
    
    Bitkub API server url
Returns API

Properties

Private _server_url

_server_url: string = DEFAULT_SERVER_URL

Methods

Private _build_non_secure_endpoint_function

_build_non_secure_endpoint_function(data: endPointData): (Anonymous function)

- Defined in api/index.ts:53
Build non-secure API endpoint function

Parameters
- data: endPointData
Returns (Anonymous function)

Private _build_parameters_validator

_build_parameters_validator(parameters: object): (Anonymous function)

- Defined in api/index.ts:105
Build parameter validator function

Parameters
- parameters: object
  - [key: string]: boolean
Returns (Anonymous function)

Private _build_secure_endpoint_function

_build_secure_endpoint_function(data: endPointData): (Anonymous function)

- Defined in api/index.ts:74
Build secure API endpoint function

Parameters
- data: endPointData
Returns (Anonymous function)

Private _generate_signature

_generate_signature(json: any): string

- Defined in api/index.ts:95
Generate HMAC signature from json parameters

Parameters
- json: any
Returns string

Object literals

Private _credentials

_credentials: object

api_key

api_key: string = ""

api_secret

api_secret: string = ""

Generated using TypeDoc