Global

Members

(constant) AUTH_METHODS :Object

Kind of authentication.

Type:
  • Object
Source:

(constant) CONFIG :object

Contains base configuration for different environments.

Type:
  • object
Properties:
Name Type Description
staging EnvironmentConfig

Staging configuration

production EnvironmentConfig

Production configuration

Source:

(constant) ENVIRONMENT :Object

Environment names.

Type:
  • Object
Source:

(constant) PATHS :Object

Paths to the Wallet API.

Type:
  • Object
Source:

Type Definitions

BalanceResponse

Contains balances for all supported coins.

Type:
  • object
Source:

CelsiusInstance

Type:
  • object
Properties:
Name Type Description
getKycStatus function

Method for sending GET requests

verifyKyc function

Method for sending POST requests. Data is transmitted using multipart/form-data

Source:

Documents

Type:
  • Object
Properties:
Name Type Description
document_front_image string
document_back_image string
Source:

EnvironmentConfig

Type:
  • object
Properties:
Name Type Description
baseUrl string

Base url for the environment.

publicKey string

Public key used to verify signatures of responses.

Source:

FormFields

Type:
  • Object
Properties:
Name Type Description
address string

Address where funds need to be sent

amount number
Source:

HttpClient

Type:
  • object
Properties:
Name Type Description
get function

Method for sending GET requests

post function

Method for sending POST requests. Data is transmitted using multipart/form-data

Source:

InterestResponse

Contains interest earned so far for all supported coins and total interest earned in usd.

Type:
  • object
Source:

KYCStatus

KYC Status Description
Pending Waiting on user to provide documents for verification
Completed User has provided documents and is waiting to be verified
Passed User was successfully verified
Rejected User has failed verification
Type:
  • string
Source:

Pagination

Type:
  • Object
Properties:
Name Type Description
page number

Which page will be returned

perPage number

Number of results to be returned per page

Source:

StatisticsResponse

Contains statistical data about users.

Type:
  • object
Properties:
Name Type Description
depositCount string | number

Contains number of deposits made by the user

depositAmount Object

Contains total amount deposited per coin as well as total amount deposited in usd

withdrawalCount string | number

Contains number of withdrawals made by the user

withdrawalAmount Object

Contains total amount withdrawn per coin as well as total amount withdrawn in usd

interestCount string | number

Contains number of interests earned by the user

interestAmount Object

Contains total amount earned per coin as well as total amount earned in usd

Source:

UserData

Type:
  • Object
Properties:
Name Type Description
first_name string
last_name string
date_of_birth string
citizenship string
country string
state string
city string
zip string
street string
building_number string
flat_number string
itin string
national_id string
ssn string
middle_name string
title string
gender string
phone_number string
document_type string
Source:

Util

Type:
  • object
Properties:
Name Type Description
getFormData function

Method for getting form data from formFields and files

readFile function

Method for reading files

verifyResponse function

Method for verifying responses

Source: