Exchange API.¶

Informations¶

Version¶

0.0.1

Content negotiation¶

URI Schemes¶

http
https

Consumes¶

application/json
multipart/form-data

Produces¶

application/json

Access control¶

Security Schemes¶

Bearer (header: Authorization)¶

Enter the token with the Bearer: prefix, e.g. "Bearer abcde12345".

Type: apikey

All endpoints¶

apiops¶

Method	URI	Name	Summary
POST	/api/travel-rule/deposits/{uuid}/originator-data	add deposit originator data	Submit travel-rule originator data for a deposit transaction
PUT	/api/preferences/symbols/{pref_key}/{symbol_id}	add preference symbol	Add symbol to favourites.
POST	/api/referral	add referral link	Add referral link.
POST	/api/travel-rule/withdrawals/{uuid}	add withdrawal t r data	Submit travel-rule data for a withdrawal transaction (temporary implementation)
DELETE	/api/wallet/fiat/withdrawals/{id}	cancel fiat withdrawal	Cancel pending fiat withdrawal request.
DELETE	/api/spot/orders/{id}	cancel order	Cancel existing order
DELETE	/api/spot/orders	cancel user orders	Cancel all existing orders
GET	/api/wallet/deposit-address/exists	check recipient address	Check if deposit address exists on the platform.
POST	/api/wallet/fiat/deposits/{id}/confirm	confirm fiat deposit	Confirm fiat deposit request
POST	/api/wallet/transactions/balance_transfer	create balance transfer	Create internal balance transfer.
POST	/api/wallet/fiat/deposits	create fiat deposit	Create fiat deposit request and return platform bank details.
POST	/api/wallet/fiat/withdrawals	create fiat withdrawal	Create fiat withdrawal request.
POST	/api/spot/orders	create order	Creates new order
POST	/api/wallet/transactions/transfer	create transfer	Create internal transfer (operation) between users.
POST	/api/wallet/transactions/withdraw	create withdrawal	Create withdrawal (operation) for specified assets
DELETE	/api/auth/notifications	delete notifications	Delete all/group of notifications. Body is optional.
DELETE	/api/preferences/symbols/{pref_key}/{symbol_id}	delete preference symbol	Delete symbol from favourites.
GET	/api/referral/export	export referral fees	Export history of fees to xlsx file
GET	/api/spot/orders/active	get active orders	Get active orders of user
GET	/api/wallet/balances/history	get balance history	Get balance history for user
GET	/api/datasource/coin-info	get coin info	get coin info by asset id and source id
GET	/api/datasource/prices/assets	get datasource asset	Get datasource assets price.
GET	/api/datasource/prices/sources	get datasources	Get datasource list.
GET	/api/auth/notifications	get notifications	Get notifications for user
GET	/api/wallet/transactions/deposit	get or create deposit address	Get or create deposit address
GET	/api/spot/orders	get orders history	Get orders history for user
GET	/api/referral/percents	get percents	Get current percents of referral program.
GET	/api/wallet/pnl	get pnl	Get user pnl
GET	/api/datasource/prices/history	get prices history	get datasource prices history by asset id, coin id, source id and interval endpoint handler
GET	/api/user	get profile	GetProfile returns information about current user.
GET	/api/referral/{id}	get referral link details	Get details of referral link.
GET	/api/referral/program	get referral program	Get header of referral program.
GET	/api/spot/trades	get trades history	Get trades history for user
GET	/api/wallet/balances	list balances	Get balances
GET	/api/wallet/fiat/transactions	list fiat transactions	Get user fiat transactions history.
GET	/api/wallet/lite-balances	list lite balances	Get balances for lite version.
GET	/api/spot/lite-symbols	list lite symbols	Get trade assets (symbols ASSET_USDT) for lite version.
GET	/api/referral/fees	list referral fees	Get history of fees
GET	/api/referral	list referral links	Get list of referral link.
GET	/api/wallet/transactions	list transactions	Get user transactions history.
PUT	/api/operations/{uuid}/cancel	operation cancel	Cancels operation by uuid.
PUT	/api/operations/{uuid}/confirm	operation confirm	Confirms operation by uuid and code.
PUT	/api/operations/{uuid}/resend	operation resend	Resends code to email for specified operation.
PUT	/api/auth/notifications	read notifications	Mark all/group of notifications as viewed. Body is optional.
PUT	/api/spot/orders/{id}/reduce	reduce order	Reduce quantity of existing order
PUT	/api/wallet/transactions/withdraw/{uuid}/reject	reject withdrawal	Reject withdrawal confirmed by user.
PUT	/api/referral/{id}	set default link	Set default referral link.
PUT	/api/user/flags	set profile flags	SetProfile sets profile flags of current user.
POST	/api/wallet/fiat/deposits/{id}/payment-receipt	upload fiat deposit receipt	Upload payment receipt (pdf file) for a fiat deposit.
PUT	/api/auth/notifications/{id}	view notification	Mark notification as viewed.

Paths¶

Submit travel-rule originator data for a deposit transaction (AddDepositOriginatorData)¶

POST /api/travel-rule/deposits/{uuid}/originator-data

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
uuid	`path`	string	`string`	✓	Deposit transaction UUID
Fingerprint	`header`	string	`string`	✓	user device unique id
Body	`body`	map of AddDepositOriginatorDataRequest	`map[string]models.AddDepositOriginatorDataRequest`

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	originator data accepted		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - originator data accepted¶

Status: OK

Schema¶

map of AddDepositOriginatorDataResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Add symbol to favourites. (AddPreferenceSymbol)¶

PUT /api/preferences/symbols/{pref_key}/{symbol_id}

! Need access token in bearer token authorization

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
pref_key	`path`	string	`string`	✓	Preference sections. Can be spot_symbols.
symbol_id	`path`	integer	`int64`	✓	Symbol ID
Fingerprint	`header`	string	`string`	✓	user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	symbol is added	schema
400	Bad Request	some logical error in request	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - symbol is added¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Add referral link. (AddReferralLink)¶

POST /api/referral

! Need access token in bearer token authorization

Consumes¶

application/json

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of AddReferralLinkRequest	`map[string]models.AddReferralLinkRequest`

All responses¶

Code	Status	Description	Schema
200	OK	referral link	schema
400	Bad Request	some logical error in request	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - referral link¶

Status: OK

Schema¶

map of ReferralLink

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Submit travel-rule data for a withdrawal transaction (temporary implementation) (AddWithdrawalTRData)¶

POST /api/travel-rule/withdrawals/{uuid}

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
uuid	`path`	string	`string`		✓		Withdrawal transaction UUID
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	travel-rule data accepted		schema
500	Internal Server Error	some error in internal server		schema

Responses¶

200 - travel-rule data accepted¶

Status: OK

Schema¶

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Cancel pending fiat withdrawal request. (CancelFiatWithdrawal)¶

DELETE /api/wallet/fiat/withdrawals/{id}

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	integer	`int64`		✓		Fiat withdrawal operation ID
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	fiat withdrawal cancelled		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - fiat withdrawal cancelled¶

Status: OK

Schema¶

map of CancelFiatWithdrawalResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Cancel existing order (CancelOrder)¶

DELETE /api/spot/orders/{id}

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	integer	`int64`		✓		Order ID
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	cancelled order ID	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - cancelled order ID¶

Status: OK

Schema¶

map of CancelOrderResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Cancel all existing orders (CancelUserOrders)¶

DELETE /api/spot/orders

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of CancelAllOrders	`map[string]models.CancelAllOrders`				symbol_id filter orders to cancel by symbol. symbol_id can be 0 or can be omitted to cancel all orders

All responses¶

Code	Status	Description	Schema
200	OK	cancelled symbol ID (if specified)	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - cancelled symbol ID (if specified)¶

Status: OK

Schema¶

map of CancelAllOrdersResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Check if deposit address exists on the platform. (CheckRecipientAddress)¶

GET /api/wallet/deposit-address/exists

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
address	`query`	string	`string`		✓		crypto wallet address to check

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	address existence check result		schema
500	Internal Server Error	some error in internal server		schema

Responses¶

200 - address existence check result¶

Status: OK

Schema¶

map of CheckRecipientAddressResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Confirm fiat deposit request (ConfirmFiatDeposit)¶

POST /api/wallet/fiat/deposits/{id}/confirm

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
id	`path`	integer	`int64`	✓	Fiat deposit operation ID
Fingerprint	`header`	string	`string`	✓	user device unique id
Body	`body`	map of ConfirmFiatDepositRequest	`map[string]models.ConfirmFiatDepositRequest`

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	fiat deposit bank details		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - fiat deposit bank details¶

Status: OK

Schema¶

map of ConfirmFiatDepositResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Create internal balance transfer. (CreateBalanceTransfer)¶

POST /api/wallet/transactions/balance_transfer

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of CreateBalanceTransferRequest	`map[string]models.CreateBalanceTransferRequest`

All responses¶

Code	Status	Description	Schema
200	OK	operation attributes	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - operation attributes¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Create fiat deposit request and return platform bank details. (CreateFiatDeposit)¶

POST /api/wallet/fiat/deposits

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of CreateFiatDepositRequest	`map[string]models.CreateFiatDepositRequest`

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	fiat deposit bank details		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - fiat deposit bank details¶

Status: OK

Schema¶

map of CreateFiatDepositResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Create fiat withdrawal request. (CreateFiatWithdrawal)¶

POST /api/wallet/fiat/withdrawals

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of CreateFiatWithdrawalRequest	`map[string]models.CreateFiatWithdrawalRequest`

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	operation attributes		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - operation attributes¶

Status: OK

Schema¶

map of OperationResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Creates new order (CreateOrder)¶

POST /api/spot/orders

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of CreateOrder	`map[string]models.CreateOrder`

All responses¶

Code	Status	Description	Schema
200	OK	created order ID	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - created order ID¶

Status: OK

Schema¶

map of CreateOrderResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Create internal transfer (operation) between users. (CreateTransfer)¶

POST /api/wallet/transactions/transfer

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of CreateTransferRequest	`map[string]models.CreateTransferRequest`

All responses¶

Code	Status	Description	Schema
200	OK	operation attributes	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - operation attributes¶

Status: OK

Schema¶

map of OperationResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Create withdrawal (operation) for specified assets (CreateWithdrawal)¶

POST /api/wallet/transactions/withdraw

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of CreateWithdrawalRequest	`map[string]models.CreateWithdrawalRequest`

All responses¶

Code	Status	Description	Schema
200	OK	operation attributes	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - operation attributes¶

Status: OK

Schema¶

map of OperationResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Delete all/group of notifications. Body is optional. (DeleteNotifications)¶

DELETE /api/auth/notifications

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of ManageNotificationsRequest	`map[string]models.ManageNotificationsRequest`

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	notifications are deleted.		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - notifications are deleted.¶

Status: OK

Schema¶

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Delete symbol from favourites. (DeletePreferenceSymbol)¶

DELETE /api/preferences/symbols/{pref_key}/{symbol_id}

! Need access token in bearer token authorization

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
pref_key	`path`	string	`string`	✓	Preference sections. Can be spot_symbols.
symbol_id	`path`	integer	`int64`	✓	Symbol ID
Fingerprint	`header`	string	`string`	✓	user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	symbol is added	schema
400	Bad Request	some logical error in request	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - symbol is added¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Export history of fees to xlsx file (ExportReferralFees)¶

GET /api/referral/export

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
from	`query`	integer	`int64`		Start timestamp of export
to	`query`	integer	`int64`		End timestamp of export

All responses¶

Code	Status	Description	Schema
200	OK	.xlsx file with export	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - .xlsx file with export¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get active orders of user (GetActiveOrders)¶

GET /api/spot/orders/active

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: created_at, price, quantity
symbol	`query`	string	`string`		Order symbol name

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	list of orders		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - list of orders¶

Status: OK

Schema¶

map of GetActiveOrdersResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get balance history for user (GetBalanceHistory)¶

GET /api/wallet/balances/history

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
currency	`query`	string	`string`	✓	Known currency symbol to convert all assets to one measure unit. Available values: BTC, ETH, BNB, USD, CNY, EUR
from	`query`	integer	`int64`		The from timestamp (in seconds)
to	`query`	integer	`int64`		The to timestamp (in seconds)

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	list of balances ordered by timestamp		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - list of balances ordered by timestamp¶

Status: OK

Schema¶

map of GetBalanceHistoryResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

get coin info by asset id and source id (GetCoinInfo)¶

GET /api/datasource/coin-info

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
asset_id	`query`	integer	`int64`	✓	Asset id
source_id	`query`	string	`string`	✓	Data source id

All responses¶

Code	Status	Description	Schema
200	OK		schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200¶

Status: OK

Schema¶

map of GetCoinInfoResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get datasource assets price. (GetDatasourceAsset)¶

GET /api/datasource/prices/assets

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
datasource	`query`	string	`string`		Get data from datasource
fullness	`query`	string	`string`	✓	Filter asset tickers
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request
search	`query`	string	`string`		Filter by assetName, assetTicker
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: id

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	asset		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - asset¶

Status: OK

Schema¶

map of BackendSourceAsset

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get datasource list. (GetDatasources)¶

GET /api/datasource/prices/sources

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	asset		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - asset¶

Status: OK

Schema¶

map of DatasourceList

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get notifications for user (GetNotifications)¶

GET /api/auth/notifications

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
group_id	`query`	integer	`int64`		Group of notifications. Omitted or 0 mean all.
hide_read	`query`	string	`string`		Hide read notifications. Bool value: true or false.
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	list of notifications		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - list of notifications¶

Status: OK

Schema¶

map of GetNotificationsResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get or create deposit address (GetOrCreateDepositAddress)¶

GET /api/wallet/transactions/deposit

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
blockchainType	`query`	string	`string`		✓		Network type of deposit address: EVM, TRON, BITCOIN, TON, LITECOIN.

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	deposit address		schema
500	Internal Server Error	some error in internal server		schema

Responses¶

200 - deposit address¶

Status: OK

Schema¶

map of GetOrCreateDepositResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get orders history for user (GetOrdersHistory)¶

GET /api/spot/orders

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
baseAmount	`query`	string	`string`		Order baseAmount - float number in string representation
from	`query`	integer	`int64`		Get orders created after the from timestamp (in seconds)
id	`query`	integer	`int64`		Order id to get exact order
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request
side	`query`	string	`string`		Side of order - buy or sell Available values: buy, sell
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: created_at, price, base_amount, avg_price, executed_percent
statuses	`query`	string	`string`		Comma-separated list of orders statuses Available values: new, active, executing, cancelled, executed
symbol	`query`	string	`string`		Order symbol name
to	`query`	integer	`int64`		Get orders created before the to timestamp (in seconds)
type	`query`	string	`string`		Type of order Available values: limit, market

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	list of orders		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - list of orders¶

Status: OK

Schema¶

map of GetOrdersHistoryResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get current percents of referral program. (GetPercents)¶

GET /api/referral/percents

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	Percents	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - Percents¶

Status: OK

Schema¶

map of ReferralPercents

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get user pnl (GetPnl)¶

GET /api/wallet/pnl

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	user PnL	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - user PnL¶

Status: OK

Schema¶

map of GetPnlResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

get datasource prices history by asset id, coin id, source id and interval endpoint handler (GetPricesHistory)¶

GET /api/datasource/prices/history

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
asset_id	`query`	integer	`int64`	✓	Asset id
interval	`query`	string	`string`	✓	Calculation period. Required param
source_id	`query`	string	`string`	✓	Data source id

All responses¶

Code	Status	Description	Schema
200	OK		schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200¶

Status: OK

Schema¶

map of GetPricesHistoryResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

GetProfile returns information about current user. (GetProfile)¶

GET /api/user

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	user information	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - user information¶

Status: OK

Schema¶

map of UserProfile

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get details of referral link. (GetReferralLinkDetails)¶

GET /api/referral/{id}

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
id	`path`	integer	`int64`	✓	Link internal ID
Fingerprint	`header`	string	`string`	✓	user device unique id
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request

All responses¶

Code	Status	Description	Schema
200	OK	Link details	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - Link details¶

Status: OK

Schema¶

map of ReferralLink

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get header of referral program. (GetReferralProgram)¶

GET /api/referral/program

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	Links list	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - Links list¶

Status: OK

Schema¶

map of ReferralProgram

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get trades history for user (GetTradesHistory)¶

GET /api/spot/trades

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
baseAmount	`query`	string	`string`		Amount of base asset in trade
from	`query`	integer	`int64`		Get trades created after the from timestamp (in seconds)
id	`query`	integer	`int64`		Trade id to get exact trade
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request
orderId	`query`	integer	`int64`		Order id (maker or taker) of trades
side	`query`	string	`string`		Side of order. Possible values are 'buy', 'sell'.
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: id, created_at, base_amount, quote_amount, symbol, price, fee
symbol	`query`	string	`string`		Symbol name of trades
to	`query`	integer	`int64`		Get trades created before the to timestamp (in seconds)

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	list of trades		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - list of trades¶

Status: OK

Schema¶

map of GetTradesHistoryResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get balances (ListBalances)¶

GET /api/wallet/balances

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
asset	`query`	string	`string`		Asset ticker
type	`query`	string	`string`		Balance type

All responses¶

Code	Status	Description	Schema
200	OK	user balances	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - user balances¶

Status: OK

Schema¶

[]Balance

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get user fiat transactions history. (ListFiatTransactions)¶

GET /api/wallet/fiat/transactions

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
cursor	`query`	string	`string`		Cursor value to scroll. If specified, all other filters will be ignored.
from	`query`	integer	`int64`		Get transactions created after the from timestamp (in seconds)
limit	`query`	integer	`int64`		Limit of records in request
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: operation_id, created_at
to	`query`	integer	`int64`		Get transactions created before the to timestamp (in seconds)
type	`query`	string	`string`		Type of fiat transaction
uiStatus	`query`	string	`string`		Fiat transaction status

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	list of fiat transactions		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - list of fiat transactions¶

Status: OK

Schema¶

map of ListFiatTransactions

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get balances for lite version. (ListLiteBalances)¶

GET /api/wallet/lite-balances

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request
search	`query`	string	`string`		Search by asset ticker or name.
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: asset, available, total, total_in_currency
type	`query`	string	`string`	✓	Balance type

All responses¶

Code	Status	Description	Schema
200	OK	user balances	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - user balances¶

Status: OK

Schema¶

map of ListLiteBalanceResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get trade assets (symbols ASSET_USDT) for lite version. (ListLiteSymbols)¶

GET /api/spot/lite-symbols

Produces¶

application/json

Parameters¶

Name	Source	Type	Go type	Description
favourites	`query`	string	`string`	Logical 'true' of 'false'. If set to 'true' select only favourites assets.
limit	`query`	integer	`int64`	Limit of records in request
offset	`query`	integer	`int64`	Offset of records in request
search	`query`	string	`string`	Search by ticket or name
sortBy	`query`	string	`string`	Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: asset,last_price,price_change_24

All responses¶

Code	Status	Description	Has headers	Schema
200	OK			schema
500	Internal Server Error	some error in internal server		schema

Responses¶

200¶

Status: OK

Schema¶

map of LiteSymbol

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get history of fees (ListReferralFees)¶

GET /api/referral/fees

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: link_id, referral_level

All responses¶

Code	Status	Description	Schema
200	OK	Fees list	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - Fees list¶

Status: OK

Schema¶

map of ListReferralFeesResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get list of referral link. (ListReferralLinks)¶

GET /api/referral

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
limit	`query`	integer	`int64`		Limit of records in request
offset	`query`	integer	`int64`		Offset of records in request
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: id, created_at

All responses¶

Code	Status	Description	Schema
200	OK	Links list	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - Links list¶

Status: OK

Schema¶

map of ListReferralLinksResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Get user transactions history. (ListTransactions)¶

GET /api/wallet/transactions

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
Fingerprint	`header`	string	`string`	✓	user device unique id
assetId	`query`	integer	`int64`		Transaction asset ID
cursor	`query`	string	`string`		Cursor value to scroll. If specified, all other filters will be ignored.
from	`query`	integer	`int64`		Get transactions created after the from timestamp (in seconds)
limit	`query`	integer	`int64`		Limit of records in request
search	`query`	string	`string`		Partial matching transaction UUID; wallet address; transaction hash
sortBy	`query`	string	`string`		Comma-separated list of sort order. Every item must be field name:sort order. Sort order must be 'asc' or 'desc' Available values: amount, created_at
status	`query`	string	`string`		Common transaction status
to	`query`	integer	`int64`		Get transactions created before the to timestamp (in seconds)
type	`query`	string	`string`		Type of transaction

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	list of transactions		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - list of transactions¶

Status: OK

Schema¶

map of ListTransactionsResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Cancels operation by uuid. (OperationCancel)¶

PUT /api/operations/{uuid}/cancel

! Need access token in bearer token authorization

Consumes¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
uuid	`path`	string	`string`		✓		UUID of transaction
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	operation cancelled	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - operation cancelled¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Confirms operation by uuid and code. (OperationConfirm)¶

PUT /api/operations/{uuid}/confirm

! Need access token in bearer token authorization

Consumes¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
uuid	`path`	string	`string`	✓	UUID of operation
Fingerprint	`header`	string	`string`	✓	user device unique id
Body	`body`	map of OperationConfirmRequest	`map[string]models.OperationConfirmRequest`

All responses¶

Code	Status	Description	Schema
200	OK	operation completed	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - operation completed¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Resends code to email for specified operation. (OperationResend)¶

PUT /api/operations/{uuid}/resend

! Need access token in bearer token authorization

Consumes¶

application/json

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
uuid	`path`	string	`string`		✓		UUID of transaction
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	operation attributes	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - operation attributes¶

Status: OK

Schema¶

map of OperationResponse

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Mark all/group of notifications as viewed. Body is optional. (ReadNotifications)¶

PUT /api/auth/notifications

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of ManageNotificationsRequest	`map[string]models.ManageNotificationsRequest`

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	notifications are marked as viewed.		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - notifications are marked as viewed.¶

Status: OK

Schema¶

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Reduce quantity of existing order (ReduceOrder)¶

PUT /api/spot/orders/{id}/reduce

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
id	`path`	integer	`int64`	✓	Order ID
Fingerprint	`header`	string	`string`	✓	user device unique id
Body	`body`	map of ReduceOrderRequest	`map[string]models.ReduceOrderRequest`

All responses¶

Code	Status	Description	Schema
200	OK	order quantity is reduced	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - order quantity is reduced¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Reject withdrawal confirmed by user. (RejectWithdrawal)¶

PUT /api/wallet/transactions/withdraw/{uuid}/reject

! Need Bearer token and OTP authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
uuid	`path`	string	`string`	✓	Transaction UUID
Fingerprint	`header`	string	`string`	✓	user device unique id
type	`query`	string	`string`		Reject type

All responses¶

Code	Status	Description	Schema
200	OK	withdrawal is rejected	schema
400	Bad Request	some logical error in request	schema
401	Unauthorized	unauthorized error	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - withdrawal is rejected¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

401 - unauthorized error¶

Status: Unauthorized

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Set default referral link. (SetDefaultLink)¶

PUT /api/referral/{id}

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	integer	`int64`		✓		Link internal ID
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Schema
200	OK	referral link is set as default	schema
400	Bad Request	some logical error in request	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - referral link is set as default¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

SetProfile sets profile flags of current user. (SetProfileFlags)¶

PUT /api/user/flags

! Need access token in bearer token authorization

Consumes¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
Fingerprint	`header`	string	`string`		✓		user device unique id
Body	`body`	map of SetUserProfileFlags	`map[string]models.SetUserProfileFlags`				profile flag.

All responses¶

Code	Status	Description	Schema
200	OK	profile is updated successful	schema
400	Bad Request	some logical error in request	schema
500	Internal Server Error	some error in internal server	schema

Responses¶

200 - profile is updated successful¶

Status: OK

Schema¶

400 - some logical error in request¶

Status: Bad Request

Schema¶

map of ErrorResponse

500 - some error in internal server¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Upload payment receipt (pdf file) for a fiat deposit. (UploadFiatDepositReceipt)¶

POST /api/wallet/fiat/deposits/{id}/payment-receipt

! Need access token in bearer token authorization

Consumes¶

multipart/form-data

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Required	Description
id	`path`	integer	`int64`	✓	Fiat deposit operation ID
Fingerprint	`header`	string	`string`	✓	user device unique id
file	`formData`	file	`io.ReadCloser`	✓	Payment receipt (pdf)

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	receipt uploaded		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - receipt uploaded¶

Status: OK

Schema¶

map of UploadFiatDepositReceiptResponse

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Mark notification as viewed. (ViewNotification)¶

PUT /api/auth/notifications/{id}

! Need access token in bearer token authorization

Produces¶

application/json

Security Requirements¶

Bearer

Parameters¶

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	integer	`int64`		✓		ID of notifications.
Fingerprint	`header`	string	`string`		✓		user device unique id

All responses¶

Code	Status	Description	Has headers	Schema
200	OK	notification is marked as viewed.		schema
500	Internal Server Error	internal server error		schema

Responses¶

200 - notification is marked as viewed.¶

Status: OK

Schema¶

500 - internal server error¶

Status: Internal Server Error

Schema¶

map of ErrorResponse

Models¶

APIKeyListItem¶

Properties

Name	Type	Go type
APIKeyMask	string	`string`
AccountID	uint64 (formatted integer)	`uint64`
CreatedAt	string	`string`
ExpiresAt	string	`string`
ID	uint64 (formatted integer)	`uint64`
IPWhitelist	[]string	`[]string`
Label	string	`string`
Permissions	[]APIKeyPermissionEntry	`[]*APIKeyPermissionEntry`
SecretKeyMask	string	`string`
Status	string	`string`
UpdatedAt	string	`string`
UpdatedBy	uint64 (formatted integer)	`uint64`

APIKeyPermissionEntry¶

Properties

Name	Type	Go type
Endpoint	string	`string`
Group	string	`string`
Method	string	`string`

ActiveOrder¶

ActiveOrder represents a one item of active orders

Properties

Name	Type	Go type
AccountID	uint64 (formatted integer)	`uint64`
AvgPrice	string	`string`
CreatedAt	uint64 (formatted integer)	`uint64`
Executed	string	`string`
ID	uint64 (formatted integer)	`uint64`
LinkedOrderID	uint64 (formatted integer)	`uint64`
Price	string	`string`
Quantity	string	`string`
Side	string	`string`
Status	string	`string`
StopPrice	string	`string`
Symbol	string	`string`
TakeProfit	boolean	`bool`
TimeInForce	string	`string`
Type	string	`string`

AddDepositOriginatorDataRequest¶

Properties

Name	Type	Go type
AdditionalIdentifierType	string	`string`
AddressCity	string	`string`
AddressCountry	string	`string`
AddressLine	string	`string`
CounterpartyType	string	`string`
CustomerIdentificationNumber	string	`string`
DateOfBirth	string	`string`
FullName	string	`string`
IsConfirmed	boolean	`bool`
NationalIdentityNumber	string	`string`
PlaceOfBirth	string	`string`
PostalCode	string	`string`
Vasp	string	`string`

AddDepositOriginatorDataResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
TransactionUUID	string	`string`

AddReferralLinkRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
IsDefault	boolean	`bool`

AllowedApiKeyPermissionItem¶

Properties

Name	Type	Go type
Alias	string	`string`
Endpoint	string	`string`
Group	string	`string`
Method	string	`string`

AllowedApiKeyPermissionsResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Permissions	[]AllowedAPIKeyPermissionItem	`[]*AllowedAPIKeyPermissionItem`

AllowedCountries¶

[]AllowedCountryItem

AllowedCountryItem¶

Properties

Name	Type	Go type	Required	Default	Description	Example
CountryCode	string	`string`
CountryName	string	`string`

AntiFraudView¶

Properties

Name	Type	Go type
Enabled	boolean	`bool`
Masked	string	`string`
UpdatedAt	string	`string`

Asset¶

Asset represents a asset

Properties

Name	Type	Go type
DepositEnabled	boolean	`bool`
ID	uint32 (formatted integer)	`uint32`
Icon	string	`string`
IsFiat	boolean	`bool`
MinimalDeposit	string	`string`
MinimalTransfer	string	`string`
Name	string	`string`
Networks	[]AssetNetwork	`[]*AssetNetwork`
Rails	[]AssetRail	`[]*AssetRail`
Ticker	string	`string`
TradingEnabled	boolean	`bool`
TransferEnabled	boolean	`bool`
USDPrice	string	`string`
WithdrawalEnabled	boolean	`bool`

AssetNetwork¶

Properties

Name	Type	Go type	Description
Decimals	uint32 (formatted integer)	`uint32`	Number of digits after comma as defined in native coin/token description.
DepositEnabled	boolean	`bool`
ID	uint16 (formatted integer)	`uint16`
MinimalWithdrawal	string	`string`
Name	string	`string`
Precision	uint32 (formatted integer)	`uint32`	Number of digits after comma, BUT it less or equal to Uint type precision. It is used by frontend to calculate right amounts.
WithdrawalCommission	string	`string`
WithdrawalEnabled	boolean	`bool`

AssetRail¶

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	uint32 (formatted integer)	`uint32`
Type	string	`string`

BackendSourceAsset¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
SourceData	[]BackendSourceData	`[]*BackendSourceData`

BackendSourceData¶

Properties

Name	Type	Go type
AssetName	string	`string`
CreatedAt	uint64 (formatted integer)	`uint64`
ID	uint32 (formatted integer)	`uint32`
Price	string	`string`

Balance¶

Properties

Name	Type	Go type
Asset	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
Available	string	`string`
Icon	string	`string`
Locked	string	`string`
Total	string	`string`
TotalInCurrency	string	`string`
Type	string	`string`

BalanceHistoryItem¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Timestamp	uint64 (formatted integer)	`uint64`

BalancesEvent¶

Properties

Name	Type	Go type
AccountID	uint64 (formatted integer)	`uint64`
Asset	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
Available	string	`string`
Locked	string	`string`
Total	string	`string`
TotalInCurrency	string	`string`
Type	string	`string`

CancelAllOrders¶

Properties

Name	Type	Go type	Required	Default	Description	Example
SymbolID	uint32 (formatted integer)	`uint32`

CancelAllOrdersResponse¶

CancelAllOrdersResponse represents a cancel all orders response

Properties

Name	Type	Go type	Required	Default	Description	Example
AccountID	uint64 (formatted integer)	`uint64`
SymbolID	uint32 (formatted integer)	`uint32`

CancelFiatWithdrawalResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
OperationID	uint64 (formatted integer)	`uint64`
Status	string	`string`

CancelOrderResponse¶

CancelOrderResponse represents a cancel order request

Properties

Name	Type	Go type	Required	Default	Description	Example
AccountID	uint64 (formatted integer)	`uint64`
OrderID	uint64 (formatted integer)	`uint64`

ChangePasswordRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
NewPassword	string	`string`
OldPassword	string	`string`

CheckRecipientAddressResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
AccountID	uint64 (formatted integer)	`uint64`
Exists	boolean	`bool`

CheckRemoveAccount¶

If user has assets or orders, he can't remove account.

Properties

Name	Type	Go type	Required	Default	Description	Example
HasBalance	boolean	`bool`
HasSpotOrders	boolean	`bool`

CompanyRegisterRequest¶

Properties

Name	Type	Go type
CompanyName	string	`string`
Country	string	`string`
Email	string	`string`
EmailCode	string	`string`
Name	string	`string`
Password	string	`string`
ReferralID	string	`string`

ConfirmFiatDepositRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
PaymentReceiptFileID	string	`string`

ConfirmFiatDepositResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
OperationID	uint64 (formatted integer)	`uint64`
Status	string	`string`

CountryByIP¶

Properties

Name	Type	Go type
CountryCode	string	`string`
CountryIcon	string	`string`
CountryName	string	`string`
IsForbidden	boolean	`bool`

CreateApiKeyRequest¶

Properties

Name	Type	Go type
IPWhitelist	[]string	`[]string`
Label	string	`string`
Permissions	[]APIKeyPermissionEntry	`[]*APIKeyPermissionEntry`
TTLSeconds	uint64 (formatted integer)	`uint64`

CreateApiKeyResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
APIKey	string	`string`
APISecret	string	`string`

CreateBalanceTransferRequest¶

CreateBalanceTransferRequest

Properties

Name	Type	Go type	Required
Amount	string	`string`	✓
AssetID	uint32 (formatted integer)	`uint32`	✓
From	string	`string`	✓
To	string	`string`	✓

CreateFiatDepositRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
AssetID	uint32 (formatted integer)	`uint32`
RailID	uint32 (formatted integer)	`uint32`

CreateFiatDepositResponse¶

Properties

Name	Type	Go type
AccountNumber	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
BankAddress	string	`string`
BankName	string	`string`
BeneficiaryName	string	`string`
IBAN	string	`string`
OperationID	uint64 (formatted integer)	`uint64`
RequestExpiresAt	int64 (formatted integer)	`int64`
SwiftBic	string	`string`

CreateFiatWithdrawalRequest¶

Properties

Name	Type	Go type
AccountNumber	string	`string`
Amount	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
BankAddress	string	`string`
BankName	string	`string`
BeneficiaryName	string	`string`
IBAN	string	`string`
RailID	uint32 (formatted integer)	`uint32`
SwiftBic	string	`string`

CreateOrder¶

CreateOrder represents a create order request

Properties

Name	Type	Go type
LimitPriceOCO	string	`string`
MarketSlippage	string	`string`
MaxVisibleQuantity	string	`string`
Price	string	`string`
Quantity	string	`string`
QuoteQuantity	string	`string`
Side	string	`string`
StopPrice	string	`string`
Symbol	string	`string`
TimeInForce	string	`string`
TrailingDistance	string	`string`
TrailingDistancePercentage	string	`string`
TrailingStep	string	`string`
TrailingStepPercentage	string	`string`
Type	string	`string`

CreateOrderResponse¶

CreateOrderResponse represents a create order request

Properties

Name	Type	Go type
AccountID	uint64 (formatted integer)	`uint64`
LinkedOrderID	uint64 (formatted integer)	`uint64`
OrderID	uint64 (formatted integer)	`uint64`

CreateTransferRequest¶

If both are specified, recipient_id will be chosen.

Properties

Name	Type	Go type	Required
Amount	string	`string`	✓
AssetID	uint32 (formatted integer)	`uint32`	✓
RecipientEmail	string	`string`
RecipientID	uint64 (formatted integer)	`uint64`

CreateWithdrawalRequest¶

CreateWithdrawalRequest represents a withdrawal request

Properties

Name	Type	Go type	Required	Description
Address	string	`string`	✓
Amount	string	`string`	✓
AssetID	uint32 (formatted integer)	`uint32`	✓
NetworkID	uint16 (formatted integer)	`uint16`	✓
TagOrMemo	string	`string`		optional tag / memo for chains that require it

DatasourceList¶

Properties

Name	Type	Go type	Required	Default	Description	Example
List	[]string	`[]string`

DefaultLink¶

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	uint64 (formatted integer)	`uint64`
LinkID	string	`string`

DeletedSymbolEvent¶

Properties

Name	Type	Go type
Deleted	boolean	`bool`
ID	uint32 (formatted integer)	`uint32`
Name	string	`string`

EmailConfirmationRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Email	string	`string`

EmailConfirmationResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
ResendTime	uint64 (formatted integer)	`uint64`

ErrorResponse¶

ErrorResponse represents http error response

Properties

Name	Type	Go type	Required	Default	Description	Example
Code	uint32 (formatted integer)	`uint32`
Message	string	`string`

FiatTransaction¶

Properties

Name	Type	Go type
Amount	string	`string`
CreatedAt	int64 (formatted integer)	`int64`
Icon	string	`string`
OperationID	uint64 (formatted integer)	`uint64`
ReceiptURL	string	`string`
Status	string	`string`
Ticker	string	`string`
Type	string	`string`
UIStatus	string	`string`

GetActiveOrdersResponse¶

GetActiveOrdersResponse represents active orders

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
Data	[]ActiveOrder	`[]*ActiveOrder`

GetBalanceHistoryResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Items	[]BalanceHistoryItem	`[]*BalanceHistoryItem`

GetCoinInfoResponse¶

Properties

Name	Type	Go type
AssetID	uint32 (formatted integer)	`uint32`
CoinID	string	`string`
CreatedAt	uint64 (formatted integer)	`uint64`
Description	string	`string`
MarketCap	string	`string`
MarketCapRank	string	`string`
PriceChangePercentage24h	string	`string`
SourceID	string	`string`
TotalVolume	string	`string`

GetNotificationsResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
Data	[]UserNotification	`[]*UserNotification`

GetOrCreateDepositResponse¶

GetOrCreateDepositResponse represents a get or create deposit address response

Properties

Name	Type	Go type	Required	Default	Description	Example
Address	string	`string`

GetOrdersHistoryResponse¶

GetOrdersHistoryResponse represents a history of orders

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
Data	[]HistoryOrder	`[]*HistoryOrder`

GetPnlResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Pnl	float (formatted number)	`float32`

GetPricesHistoryResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Data	[]PricePoint	`[]*PricePoint`

GetTimeResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Time	int64 (formatted integer)	`int64`

GetTradesHistoryResponse¶

GetTradesHistoryResponse represents a response to trades history request

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
Data	[]Trade	`[]*Trade`

GlobalFlags¶

Properties

Name	Type	Go type
Authentication	boolean	`bool`
Deposits	boolean	`bool`
Registration	boolean	`bool`
Spot	boolean	`bool`
Transfers	boolean	`bool`
Withdrawals	boolean	`bool`

HistoryOrder¶

HistoryOrder represents a one item in history of orders

Properties

Name	Type	Go type
AccountID	uint64 (formatted integer)	`uint64`
AvgPrice	string	`string`
BaseAmount	string	`string`
CreatedAt	uint64 (formatted integer)	`uint64`
Executed	string	`string`
ExecutedPercent	float (formatted number)	`float32`
ID	uint64 (formatted integer)	`uint64`
LinkedOrderID	uint64 (formatted integer)	`uint64`
Price	string	`string`
Side	string	`string`
Status	string	`string`
StopPrice	string	`string`
Symbol	string	`string`
TakeProfit	boolean	`bool`
TimeInForce	string	`string`
Type	string	`string`

KYBData¶

KYBData groups the per-tier KYB verification state of a company. A tier the company never attempted is omitted rather than serialized as null.

Properties

Name	Type	Go type	Required	Default	Description	Example
kyb1	KYBLevelData	`KYBLevelData`
kyb2	KYBLevelData	`KYBLevelData`

KYBDocumentChecklistItem¶

Properties

Name	Type	Go type
DisplayName	string	`string`
DocumentType	string	`string`
RejectionReason	string	`string`
Status	string	`string`
UploadedAt	int64 (formatted integer)	`int64`

KYBLevelData¶

Properties

Name	Type	Go type
KYBStatus	string	`string`
LevelName	string	`string`
RejectionReason	string	`string`
ReviewedAt	int64 (formatted integer)	`int64`
SubmittedAt	int64 (formatted integer)	`int64`

KYBStatusResponse¶

Properties

Name	Type	Go type
DocumentChecklist	[]KYBDocumentChecklistItem	`[]*KYBDocumentChecklistItem`
KYBStatus	string	`string`
MissingFields	[]string	`[]string`
RejectionReason	string	`string`
ReviewedAt	int64 (formatted integer)	`int64`
SubmittedAt	int64 (formatted integer)	`int64`
VerificationStatus	string	`string`
VerifiedUntil	int64 (formatted integer)	`int64`
kybData	KYBData	`KYBData`

KYBToken¶

Properties

Name	Type	Go type	Description
AccessToken	string	`string`	Sumsub widget access token; empty when kybStatus is final (approved, rejected)
ExpiresIn	int64 (formatted integer)	`int64`	Token lifetime in seconds; 0 when no token is issued
KYBStatus	string	`string`

KYCToken¶

Properties

Name	Type	Go type	Required	Default	Description	Example
ExpiresAt	int64 (formatted integer)	`int64`
Token	string	`string`

LastTradesEvent¶

Properties

Name	Type	Go type
Amount	string	`string`
CreatedAt	int64 (formatted integer)	`int64`
Price	string	`string`
PriceChange	string	`string`
Symbol	string	`string`
SymbolID	uint32 (formatted integer)	`uint32`

LastTradesEvents¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Events	[]LastTradesEvent	`[]*LastTradesEvent`
Symbol	string	`string`

LevelSummary¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Referrals	int64 (formatted integer)	`int64`
Rewards	string	`string`

LinkSummary¶

Properties

Name	Type	Go type
LiquidityFee	string	`string`
level1	LevelSummary	`LevelSummary`
level2	LevelSummary	`LevelSummary`
level3	LevelSummary	`LevelSummary`
total	LevelSummary	`LevelSummary`

ListFiatTransactions¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Data	[]FiatTransaction	`[]*FiatTransaction`
NextCursor	string	`string`

ListLiteBalanceResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
Data	[]LiteBalance	`[]*LiteBalance`

ListReferralFeesResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	int64 (formatted integer)	`int64`
Data	[]ReferralFee	`[]*ReferralFee`

ListReferralLinksResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
Data	[]ReferralLink	`[]*ReferralLink`

ListSessionsResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	uint64 (formatted integer)	`uint64`
Data	[]SessionItem	`[]*SessionItem`

ListTransactionsResponse¶

ListTransactionsResponse represents a transactions

Properties

Name	Type	Go type	Required	Default	Description	Example
Data	[]Transaction	`[]*Transaction`
NextCursor	string	`string`

ListTwSymbolsResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	int64 (formatted integer)	`int64`
Symbols	[]TwSymbol	`[]*TwSymbol`

LiteBalance¶

Properties

Name	Type	Go type
Asset	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
Available	string	`string`
BalanceType	string	`string`
Icon	string	`string`
Name	string	`string`
Total	string	`string`
TotalInCurrency	string	`string`

LiteSymbol¶

Properties

Name	Type	Go type
Asset	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
Icon	string	`string`
IsFavourite	boolean	`bool`
LastPrice	string	`string`
Name	string	`string`
PriceChangeDirection	string	`string`
PriceChangePercent24	string	`string`
Symbol	string	`string`
SymbolID	uint32 (formatted integer)	`uint32`

ManageNotificationsRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
DeleteScope	string	`string`
GroupID	uint32 (formatted integer)	`uint32`

MitigateOrderRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Price	string	`string`
Quantity	string	`string`

Network¶

Network represents a network

Properties

Name	Type	Go type
AccountsUrl	string	`string`
Active	boolean	`bool`
BlockchainType	string	`string`
ID	uint16 (formatted integer)	`uint16`
Name	string	`string`
TransactionsUrl	string	`string`

OAuth2Link¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Link	string	`string`

OAuth2SignInRequest¶

Properties

Name	Type	Go type
Code	string	`string`
ErrorReason	string	`string`
State	string	`string`

OAuth2SignUpRequest¶

Properties

Name	Type	Go type
Code	string	`string`
CountryCode	string	`string`
ErrorReason	string	`string`
ReferralID	string	`string`
State	string	`string`

OperationConfirmRequest¶

Properties

Name	Type	Go type
AuthMethod	string	`string`
EmailCode	string	`string`
OtpCode	string	`string`

OperationResponse¶

Properties

Name	Type	Go type
Email2FA	boolean	`bool`
EmailHint	string	`string`
ExpiresAt	uint64 (formatted integer)	`uint64`
Otp2FA	boolean	`bool`
ResendEmailAfter	uint64 (formatted integer)	`uint64`
UUID	string	`string`

OrderBookEvent¶

Properties

Name	Type	Go type
Asks	[]WSPriceLevel	`[]*WSPriceLevel`
Bids	[]WSPriceLevel	`[]*WSPriceLevel`
Symbol	string	`string`
USDPrice	string	`string`

OrderEvent¶

Properties

Name	Type	Go type
AccountID	uint64 (formatted integer)	`uint64`
AveragePrice	string	`string`
Executed	string	`string`
LinkedOrderID	uint64 (formatted integer)	`uint64`
OrderID	uint64 (formatted integer)	`uint64`
Price	string	`string`
Quantity	string	`string`
Side	string	`string`
Status	string	`string`
StopPrice	string	`string`
Symbol	string	`string`
TakeProfit	boolean	`bool`
TimeInForce	string	`string`
Ts	uint64 (formatted integer)	`uint64`
Type	string	`string`

OtpEnableResponse¶

Properties

Name	Type	Go type
OtpImage	string	`string`
OtpKey	string	`string`
operation	OperationResponse	`OperationResponse`

PlatformCompanyResponse¶

Properties

Name	Type	Go type
CompanyID	uint64 (formatted integer)	`uint64`
CreatedAt	int64 (formatted integer)	`int64`
DepositStatus	string	`string`
Jurisdiction	string	`string`
LegalName	string	`string`
Status	string	`string`
TradingStatus	string	`string`
UpdatedAt	int64 (formatted integer)	`int64`
WithdrawalStatus	string	`string`

PricePoint¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Price	string	`string`
TS	uint64 (formatted integer)	`uint64`

ProfileFlags¶

ProfileFlags represents profile flags

any

ProfileKYC¶

Properties

Name	Type	Go type
KYC1	string	`string`
KYC2	string	`string`
KYC3	string	`string`

PublicReferralLink¶

Properties

Name	Type	Go type	Required	Default	Description	Example
LinkID	string	`string`

ReduceOrderRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
ReduceAmount	string	`string`

ReferralFee¶

Properties

Name	Type	Go type
Asset	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
Level	int64 (formatted integer)	`int64`
LinkID	string	`string`
Referrals	int64 (formatted integer)	`int64`
Reward	string	`string`

ReferralLink¶

Properties

Name	Type	Go type
CreatedAt	int64 (formatted integer)	`int64`
ID	uint64 (formatted integer)	`uint64`
IsDefault	boolean	`bool`
LinkID	string	`string`
summary	LinkSummary	`LinkSummary`

ReferralPercents¶

Properties

Name	Type	Go type
Level1	string	`string`
Level2	string	`string`
Level3	string	`string`

ReferralProgram¶

Properties

Name	Type	Go type	Required	Default	Description	Example
defaultLink	DefaultLink	`DefaultLink`
summary	ReferralProgramSummary	`ReferralProgramSummary`

ReferralProgramSummary¶

Properties

Name	Type	Go type
Earnings	string	`string`
NextPayoutDate	int64 (formatted integer)	`int64`
Referrals	int64 (formatted integer)	`int64`
StartedTrading	int64 (formatted integer)	`int64`

RefreshResponse¶

RefreshResponse represents a refreshed pair of authentication tokens

Properties

Name	Type	Go type	Required	Default	Description	Example
AccToken	string	`string`
RefreshToken	string	`string`

RemoveAccountRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Reason	string	`string`

RestorePasswordCheckResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
ExpiresAt	uint64 (formatted integer)	`uint64`
Otp2FA	boolean	`bool`

RestorePasswordFinishRequest¶

Properties

Name	Type	Go type	Required
Code	string	`string`	✓
OtpCode	string	`string`
Password	string	`string`	✓
UserID	uint64 (formatted integer)	`uint64`	✓

RestorePasswordInitRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Email	string	`string`	✓

RevokeOtherSessionsResponse¶

Properties

Name	Type	Go type
KeptSessionID	string	`string`
RevokedAt	int64 (formatted integer)	`int64`
RevokedCount	uint64 (formatted integer)	`uint64`

RevokeSessionResponse¶

Properties

Name	Type	Go type
RevokedAt	int64 (formatted integer)	`int64`
SessionID	string	`string`
Status	string	`string`

SecuritySettingsResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
antiFraud	AntiFraudView	`AntiFraudView`

SessionDevice¶

Properties

Name	Type	Go type
Browser	string	`string`
Fingerprint	string	`string`
Platform	string	`string`
UserAgent	string	`string`

SessionGeo¶

Properties

Name	Type	Go type	Required	Default	Description	Example
City	string	`string`
Country	string	`string`

SessionItem¶

Properties

Name	Type	Go type
CreatedAt	int64 (formatted integer)	`int64`
IP	string	`string`
IsCurrent	boolean	`bool`
SessionID	string	`string`
Status	string	`string`
UpdatedAt	int64 (formatted integer)	`int64`
device	SessionDevice	`SessionDevice`
geo	SessionGeo	`SessionGeo`

SetRegistrationNumberRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
RegistrationNumber	string	`string`

SetUserProfile¶

SetUserProfile represents request to set user profile

Properties

Name	Type	Go type	Required	Default	Description	Example
Avatar	string	`string`
Name	string	`string`

SetUserProfileFlags¶

SetUserProfileFlags represents request to set user profile flags

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	`string`
Value	boolean	`bool`

SignInFinalRequest¶

Properties

Name	Type	Go type
EmailCode	string	`string`
OtpCode	string	`string`
UUID	string	`string`

SignInRequest¶

SignInRequest is a request to login user

Properties

Name	Type	Go type	Required	Default	Description	Example
Email	string	`string`
Password	string	`string`

SignInResendRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Email2FA	boolean	`bool`
UUID	string	`string`

SignInResponse¶

SignInResponse represents a pair of authentication tokens

Properties

Name	Type	Go type
AccToken	string	`string`
AccountType	string	`string`
CompanyID	uint64 (formatted integer)	`uint64`
RefreshToken	string	`string`

SignUpRequest¶

Properties

Name	Type	Go type
CountryCode	string	`string`
Email	string	`string`
EmailCode	string	`string`
Name	string	`string`
Password	string	`string`
ReferralID	string	`string`

SpotCandle¶

Properties

Name	Type	Go type
Close	string	`string`
High	string	`string`
Low	string	`string`
Open	string	`string`
Time	int64 (formatted integer)	`int64`
Volume	string	`string`

SpotCandleEvent¶

Properties

Name	Type	Go type
Resolution	string	`string`
Symbol	string	`string`
candle	SpotCandle	`SpotCandle`

SpotCandlesHistoryResponse¶

Properties

Name	Type	Go type
Candles	[]SpotCandle	`[]*SpotCandle`
Count	int64 (formatted integer)	`int64`
Resolution	string	`string`
Symbol	string	`string`

Symbol¶

Symbol represents a pair

Properties

Name	Type	Go type	Description
BaseAsset	string	`string`
BaseAssetID	uint32 (formatted integer)	`uint32`
BaseAssetIcon	string	`string`
BaseVolume	string	`string`
ID	uint32 (formatted integer)	`uint32`	basic
IsFavourite	boolean	`bool`
LastPrice	string	`string`	temporary/last 24h fields
MaxPrice24	string	`string`
MinPrice24	string	`string`
Name	string	`string`
PriceChange24	string	`string`
PriceChangeDirection	string	`string`
PriceChangePercent24	string	`string`
QuoteAsset	string	`string`
QuoteAssetID	uint32 (formatted integer)	`uint32`
QuoteAssetIcon	string	`string`
QuoteVolume	string	`string`
TradingEnabled	boolean	`bool`
Type	string	`string`
USDPrice	string	`string`
config	SymbolSpotConfig	`SymbolSpotConfig`

SymbolSpotConfig¶

Properties

Name	Type	Go type
LotSizeStep	string	`string`
MakerFee	string	`string`
MaximumLotSize	string	`string`
MaximumPrice	string	`string`
MinimumLotSize	string	`string`
MinimumPrice	string	`string`
PriceStep	string	`string`
Slippage	string	`string`
TakerFee	string	`string`

SymbolsInfoEvents¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Events	[]Symbol	`[]*Symbol`

TicketResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Ticket	string	`string`

TotalBalance¶

TotalBalanceItem

TotalBalanceItem¶

Properties

Name	Type	Go type
Available	double (formatted number)	`float64`
Locked	double (formatted number)	`float64`
Total	double (formatted number)	`float64`
Type	string	`string`

Trade¶

Trade represents a trade of user

Properties

Name	Type	Go type
BaseAmount	string	`string`
CreatedAt	int64 (formatted integer)	`int64`
Fee	string	`string`
FeeAsset	string	`string`
FeeAssetID	uint32 (formatted integer)	`uint32`
ID	uint64 (formatted integer)	`uint64`
OrderID	uint64 (formatted integer)	`uint64`
Price	string	`string`
QuoteAmount	string	`string`
Side	string	`string`
Symbol	string	`string`
SymbolID	uint32 (formatted integer)	`uint32`

Transaction¶

Transaction represents a Transaction

Properties

Name	Type	Go type
Amount	string	`string`
AmountUSD	string	`string`
AssetID	uint32 (formatted integer)	`uint32`
AssetIcon	string	`string`
AssetName	string	`string`
AssetTicker	string	`string`
CreatedAt	int64 (formatted integer)	`int64`
ExpiresAt	int64 (formatted integer)	`int64`
Hash	string	`string`
RecipientID	uint64 (formatted integer)	`uint64`
ToAddress	string	`string`
Type	string	`string`
UIStatus	string	`string`
UUID	string	`string`
UpdateAt	int64 (formatted integer)	`int64`

TwConfig¶

Properties

Name	Type	Go type
Session	string	`string`
SupportedResolutions	[]string	`[]string`
SupportsGroupRequest	boolean	`bool`
SupportsMarks	boolean	`bool`
SupportsSearch	boolean	`bool`
SupportsTime	boolean	`bool`
SupportsTimescaleMarks	boolean	`bool`

TwSymbol¶

Properties

Name	Type	Go type
BaseAssetID	uint32 (formatted integer)	`uint32`
Name	string	`string`
QuoteAssetID	uint32 (formatted integer)	`uint32`
SupportedResolutions	[]string	`[]string`
SymbolID	uint32 (formatted integer)	`uint32`

TxEvent¶

Properties

Name	Type	Go type
Amount	string	`string`
Asset	string	`string`
Status	string	`string`
TxID	uint64 (formatted integer)	`uint64`
Type	string	`string`

UNTag100¶

Properties

Name	Type	Go type	Description
Amount	string	`string`	Floating number formatted as string
Asset	string	`string`
OppositeAmount	string	`string`
OppositeAsset	string	`string`
OrderID	uint64 (formatted integer)	`uint64`
OrderSide	string	`string`
OrderType	string	`string`

UNTag101¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	int64 (formatted integer)	`int64`

UNTag102¶

Properties

Name	Type	Go type	Description
Amount	string	`string`	Floating number formatted as string
Asset	string	`string`
OppositeAmount	string	`string`
OppositeAsset	string	`string`
OrderID	uint64 (formatted integer)	`uint64`
OrderSide	string	`string`
OrderType	string	`string`

UNTag103¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	int64 (formatted integer)	`int64`

UNTag104¶

Properties

Name	Type	Go type	Description
Amount	string	`string`	Floating number formatted as string
Asset	string	`string`
OppositeAmount	string	`string`
OppositeAsset	string	`string`
OrderID	uint64 (formatted integer)	`uint64`
OrderSide	string	`string`
OrderType	string	`string`

UNTag105¶

Properties

Name	Type	Go type	Description
Amount	string	`string`	Floating number formatted as string
Asset	string	`string`
OppositeAmount	string	`string`
OppositeAsset	string	`string`
OrderID	uint64 (formatted integer)	`uint64`
OrderSide	string	`string`
OrderType	string	`string`
Percent	string	`string`	Floating number formatted as string

UNTag200¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag201¶

Properties

Name	Type	Go type
Address	string	`string`
Amount	string	`string`
Asset	string	`string`
Network	string	`string`

UNTag202¶

Properties

Name	Type	Go type
Amount	string	`string`
Asset	string	`string`
RejectionReason	string	`string`

UNTag203¶

Withdrawal request created

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag204¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag205¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag206¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag207¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag208¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Address	string	`string`
Network	string	`string`

UNTag209¶

Properties

Name	Type	Go type
Amount	string	`string`
Asset	string	`string`
UUID	string	`string`

UNTag212¶

Properties

Name	Type	Go type
Amount	string	`string`
Asset	string	`string`
Network	string	`string`

UNTag213¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag214¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag215¶

Properties

Name	Type	Go type
Amount	string	`string`
Asset	string	`string`
BankName	string	`string`
Destination	string	`string`

UNTag216¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Amount	string	`string`
Asset	string	`string`

UNTag304¶

Properties

Name	Type	Go type	Required	Default	Description	Example
PublicReason	string	`string`

UNTag305¶

any

UNTag306¶

Properties

Name	Type	Go type	Required	Default	Description	Example
PublicReason	string	`string`

UNTag307¶

any

UNTag308¶

Properties

Name	Type	Go type	Required	Default	Description	Example
PublicReason	string	`string`

UNTag309¶

any

UNTag310¶

any

UNTag313¶

any

UNTag316¶

2FA is enabled

Properties

Name	Type	Go type	Required	Default	Description	Example
Method2FA	string	`string`

UNTag317¶

2FA is disabled

Properties

Name	Type	Go type	Required	Default	Description	Example
Method2FA	string	`string`

UNTag318¶

any

UNTag319¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Severity	string	`string`

UNTag320¶

any

UNTag321¶

any

UNTag322¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	`string`

UNTag323¶

Properties

Name	Type	Go type	Required	Default	Description	Example
NewEmail	string	`string`
OldEmail	string	`string`

UNTag324¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Method2FA	string	`string`

UNTag325¶

any

UNTag326¶

any

UNTag327¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Reason	string	`string`

UNTag328¶

any

UNTag329¶

any

UNTag330¶

Properties

Name	Type	Go type	Required	Default	Description	Example
RegistrationNumber	string	`string`

UNTag331¶

Properties

Name	Type	Go type	Required	Default	Description	Example
DocumentType	string	`string`
ExpiresAt	int64 (formatted integer)	`int64`			Expiry date as unix seconds (UTC).

UNTag332¶

Properties

Name	Type	Go type	Required	Default	Description	Example
DocumentType	string	`string`

UNTag333¶

Properties

Name	Type	Go type	Required	Default	Description	Example
CompanyName	string	`string`

UNTag334¶

Properties

Name	Type	Go type	Required	Default	Description	Example
CompanyName	string	`string`

UNTag335¶

Properties

Name	Type	Go type	Required	Default	Description	Example
CompanyName	string	`string`

UNTag336¶

Properties

Name	Type	Go type	Required	Default	Description	Example
KeptSessionID	string	`string`

UNTag337¶

Properties

Name	Type	Go type	Required	Default	Description	Example
DeviceInfo	string	`string`

UNTag400¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Asset	string	`string`

UNTag401¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Asset	string	`string`

UNTag402¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Symbol	string	`string`

UNTag403¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Symbol	string	`string`

UNTag500¶

Properties

Name	Type	Go type
Header	string	`string`
Link	string	`string`
Text	string	`string`

UpdateAntiFraudCodeRequest¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Code	string	`string`
Enabled	boolean	`bool`

UpdateAntiFraudCodeResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Status	string	`string`
antiFraud	AntiFraudView	`AntiFraudView`

UpdateApiKeyRequest¶

Properties

Name	Type	Go type
IPWhitelist	[]string	`[]string`
Label	string	`string`
Permissions	[]APIKeyPermissionEntry	`[]*APIKeyPermissionEntry`

UpdateCompanyRequest¶

UpdateCompanyRequest is a partial update of the owner name and the company legal name; only the non-empty fields are applied. Allowed only while KYB status is draft or rejected.

Properties

Name	Type	Go type
FirstName	string	`string`
LastName	string	`string`
LegalName	string	`string`

UploadFiatDepositReceiptResponse¶

Properties

Name	Type	Go type	Required	Default	Description	Example
PaymentReceiptFileID	string	`string`

UserNotification¶

Properties

Name	Type	Go type
Data	any	`any`
GroupID	uint32 (formatted integer)	`uint32`
ID	uint64 (formatted integer)	`uint64`
Tag	uint32 (formatted integer)	`uint32`
Ts	uint64 (formatted integer)	`uint64`
Viewed	boolean	`bool`

UserProfile¶

UserProfile represents user profile

Properties

Name	Type	Go type	Description
AccountType	string	`string`
Address	string	`string`
Avatar	string	`string`
Country	string	`string`
DateOfBirth	string	`string`
DocumentDetails	string	`string`
DocumentType	string	`string`
Email	string	`string`
FavouriteSymbols	[]string	`[]string`
FullName	string	`string`
ID	uint64 (formatted integer)	`uint64`
KYCEmail	string	`string`
KYCPhone	string	`string`
Name	string	`string`
Otp2FA	boolean	`bool`
ReferralProgramEnabled	boolean	`bool`	shows if referral program enabled for this user
SignInAt	int64 (formatted integer)	`int64`
SignUpAt	int64 (formatted integer)	`int64`
Status	string	`string`
TradeStatus	string	`string`
VerificationStatus	string	`string`	for company accounts — the company's achieved KYB verification level
WithdrawStatus	string	`string`
WithdrawUnlockAt	int64 (formatted integer)	`int64`	timestamp of unlocking withdraw ability for user (only for withdrawStatus=suspended)
kycData	ProfileKYC	`ProfileKYC`
profileFlags	ProfileFlags	`ProfileFlags`
withdrawalState	UserWithdrawalState	`UserWithdrawalState`

UserWithdrawalConfig¶

Withdrawal limits per verification level, for both account types: kyc apply to an individual account, kyb to a company account. Values are USD; "0" means the level allows no withdrawal.

Properties

Name	Type	Go type
kyb1Limit	WithdrawalKYCLimit	`WithdrawalKYCLimit`
kyb2Limit	WithdrawalKYCLimit	`WithdrawalKYCLimit`
kyb3Limit	WithdrawalKYCLimit	`WithdrawalKYCLimit`
kyc1Limit	WithdrawalKYCLimit	`WithdrawalKYCLimit`
kyc2Limit	WithdrawalKYCLimit	`WithdrawalKYCLimit`
kyc3Limit	WithdrawalKYCLimit	`WithdrawalKYCLimit`

UserWithdrawalState¶

Properties

Name	Type	Go type
DailyAmount	string	`string`
DailyLimit	string	`string`
DailyNoLimit	boolean	`bool`
DailyResetAt	int64 (formatted integer)	`int64`
MonthlyAmount	string	`string`
MonthlyLimit	string	`string`
MonthlyNoLimit	boolean	`bool`
MonthlyResetAt	int64 (formatted integer)	`int64`

WSAuthRequest¶

Properties

Name	Type	Go type
AccessToken	string	`string`
Fingerprint	string	`string`
Ticket	string	`string`

WSPriceLevel¶

Properties

Name	Type	Go type
Amount	string	`string`
OrderExists	boolean	`bool`
Price	string	`string`
Total	string	`string`

WithdrawalKYCLimit¶

Properties

Name	Type	Go type	Required	Default	Description	Example
Day	string	`string`
Month	string	`string`

wsNotificationsOKBody¶

Properties

Name	Type	Go type	Description
data	any	`any`	one of dataNNN object
data100	UNTag100	`UNTag100`
data101	UNTag101	`UNTag101`
data102	UNTag102	`UNTag102`
data103	UNTag103	`UNTag103`
data104	UNTag104	`UNTag104`
data105	UNTag105	`UNTag105`
data200	UNTag200	`UNTag200`
data201	UNTag201	`UNTag201`
data202	UNTag202	`UNTag202`
data203	UNTag203	`UNTag203`
data204	UNTag204	`UNTag204`
data205	UNTag205	`UNTag205`
data206	UNTag206	`UNTag206`
data207	UNTag207	`UNTag207`
data208	UNTag208	`UNTag208`
data209	UNTag209	`UNTag209`
data212	UNTag212	`UNTag212`
data213	UNTag213	`UNTag213`
data214	UNTag214	`UNTag214`
data215	UNTag215	`UNTag215`
data216	UNTag216	`UNTag216`
data300	UNTag300	`UNTag300`
data301	UNTag301	`UNTag301`
data302	UNTag302	`UNTag302`
data303	UNTag303	`UNTag303`
data304	UNTag304	`UNTag304`
data305	UNTag305	`UNTag305`
data306	UNTag306	`UNTag306`
data307	UNTag307	`UNTag307`
data308	UNTag308	`UNTag308`
data309	UNTag309	`UNTag309`
data310	UNTag310	`UNTag310`
data313	UNTag313	`UNTag313`
data316	UNTag316	`UNTag316`
data317	UNTag317	`UNTag317`
data318	UNTag318	`UNTag318`
data319	UNTag319	`UNTag319`
data320	UNTag320	`UNTag320`
data321	UNTag321	`UNTag321`
data322	UNTag322	`UNTag322`
data323	UNTag323	`UNTag323`
data324	UNTag324	`UNTag324`
data325	UNTag325	`UNTag325`
data326	UNTag326	`UNTag326`
data327	UNTag327	`UNTag327`
data328	UNTag328	`UNTag328`
data329	UNTag329	`UNTag329`
data330	UNTag330	`UNTag330`
data331	UNTag331	`UNTag331`
data332	UNTag332	`UNTag332`
data333	UNTag333	`UNTag333`
data334	UNTag334	`UNTag334`
data335	UNTag335	`UNTag335`
data336	UNTag336	`UNTag336`
data337	UNTag337	`UNTag337`
data400	UNTag400	`UNTag400`
data401	UNTag401	`UNTag401`
data402	UNTag402	`UNTag402`
data403	UNTag403	`UNTag403`
data500	UNTag500	`UNTag500`
tag	integer	`int64`