logo

Peatio Admin API v2

Admin API high privileged API with RBAC.

#Version: 2.4.23

Contact information:
openware.com
https://www.openware.com
[email protected]

License: https://github.com/rubykube/peatio/blob/master/LICENSE.md

/adjustments/action

POST

Description

Accepts adjustment and creates operations or reject adjustment.

Parameters
NameLocated inDescriptionRequiredSchema
idformDataUnique adjustment identifier in database.Yesinteger
actionformDataAdjustment action all available actions: [:accept, :reject]Yesstring
Responses
CodeDescriptionSchema
201Accepts adjustment and creates operations or reject adjustment.Adjustment

/adjustments/new

POST

Description

Create new adjustment.

Parameters
NameLocated inDescriptionRequiredSchema
reasonformDataAdjustment reason.Yesstring
descriptionformDataAdjustment description.Yesstring
categoryformDataAdjustment categoryYesstring
amountformDataAdjustment amount.Yesdouble
currency_idformDataAdjustment currency ID.Yesstring
asset_account_codeformDataAdjustment asset account code.Yesinteger
receiving_account_codeformDataAdjustment receiving account code.Yesinteger
receiving_member_uidformDataAdjustment receiving account code.Nostring
Responses
CodeDescriptionSchema
201Create new adjustment.Adjustment

/adjustments/{id }

GET

Description

Get adjustment by ID

Parameters
NameLocated inDescriptionRequiredSchema
idpathAdjsustment Identifier in DatabaseYesinteger
Responses
CodeDescriptionSchema
200Get adjustment by IDAdjustment

/adjustments

GET

Description

Get all adjustments, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
currencyqueryDeposit currency id.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
statequeryAdjustment's state.Nostring
categoryqueryAdjustment categoryNostring
Responses
CodeDescriptionSchema
200Get all adjustments, result is paginated.[ Adjustment ]

/orders/cancel

POST

Description

Cancel all orders.

Parameters
NameLocated inDescriptionRequiredSchema
marketformDataUnique order id.Yesstring
sideformDataIf present, only sell orders (asks) or buy orders (bids) will be cancelled.Nostring
Responses
CodeDescription
201Cancel all orders.

/orders/{id }/cancel

POST

Description

Cancel an order.

Parameters
NameLocated inDescriptionRequiredSchema
idpathUnique order id.Yesinteger
Responses
CodeDescription
201Cancel an order.

/orders

GET

Description

Get all orders, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
marketqueryUnique market id. It's always in the form of xxxyyy,where xxx is the base currency code, yyy is the quotecurrency code, e.g. 'btcusd'. All available markets canbe found at /api/v2/markets.Nostring
statequeryFilter order by state.Nostring
ord_typequeryFilter order by ord_type.Nostring
pricequeryPrice for each unit. e.g.If you want to sell/buy 1 btc at 3000 usd, the price is '3000.0'Nodouble
origin_volumequeryThe amount user want to sell/buy.An order could be partially executed,e.g. an order sell 5 btc can be matched with a buy 3 btc order,left 2 btc to be sold; in this case the order's volume would be '5.0',its remaining_volume would be '2.0', its executed volume is '3.0'.Nodouble
typequeryFilter order by type.Nostring
emailqueryMember email.Nostring
uidqueryMember UID.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all orders, result is paginated.[ Order ]

/blockchains/update

POST

Description

Update blockchain.

Parameters
NameLocated inDescriptionRequiredSchema
idformDataUnique blockchain identifier in database.Yesinteger
keyformDataUnique key to identify blockchain.Nostring
nameformDataA name to identify blockchain.Nostring
clientformDataIntegrated blockchain client.Nostring
serverformDataBlockchain server url.Nostring
heightformDataThe number of blocks preceding a particular block on blockchain.Nointeger
explorer_transactionformDataBlockchain explorer transaction template.Nostring
explorer_addressformDataBlockchain explorer address template.Nostring
statusformDataBlockchain status (active/disabled).Nostring
min_confirmationsformDataMinimum number of confirmations.Nointeger
Responses
CodeDescriptionSchema
201Update blockchain.Blockchain

/blockchains/new

POST

Description

Create new blockchain.

Parameters
NameLocated inDescriptionRequiredSchema
keyformDataUnique key to identify blockchain.Yesstring
nameformDataA name to identify blockchain.Yesstring
clientformDataIntegrated blockchain client.Yesstring
heightformDataThe number of blocks preceding a particular block on blockchain.Yesinteger
explorer_transactionformDataBlockchain explorer transaction template.Nostring
explorer_addressformDataBlockchain explorer address template.Nostring
serverformDataBlockchain server url.Nostring
statusformDataBlockchain status (active/disabled).Nostring
min_confirmationsformDataMinimum number of confirmations.Nointeger
Responses
CodeDescriptionSchema
201Create new blockchain.Blockchain

/blockchains/{id }

GET

Description

Get a blockchain.

Parameters
NameLocated inDescriptionRequiredSchema
idpathUnique blockchain identifier in database.Yesinteger
Responses
CodeDescriptionSchema
200Get a blockchain.Blockchain

/blockchains/clients

GET

Description

Get available blockchain clients.

Responses
CodeDescription
200Get available blockchain clients.

/blockchains

GET

Description

Get all blockchains, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all blockchains, result is paginated.[ Blockchain ]

/currencies/update

POST

Description

Update currency.

Parameters
NameLocated inDescriptionRequiredSchema
nameformDataCurrency nameNostring
deposit_feeformDataCurrency deposit feeNodouble
min_deposit_amountformDataMinimal deposit amountNodouble
min_collection_amountformDataMinimal collection amount.Nodouble
withdraw_feeformDataCurrency withdraw feeNodouble
min_withdraw_amountformDataMinimal withdraw amountNodouble
withdraw_limit_24hformDataCurrency 24h withdraw limitNodouble
withdraw_limit_72hformDataCurrency 72h withdraw limitNodouble
positionformDataCurrency position.Nointeger
optionsformDataCurrency options.Nojson
visibleformDataCurrency display status (true/false).NoBoolean
deposit_enabledformDataCurrency deposit possibility status (true/false).NoBoolean
withdrawal_enabledformDataCurrency withdrawal possibility status (true/false).NoBoolean
precisionformDataCurrency precision.Nointeger
icon_urlformDataCurrency iconNostring
codeformDataUnique currency code.Yesstring
symbolformDataCurrency symbolNostring
blockchain_keyformDataAssociated blockchain key which will perform transactions synchronization for currency.Nostring
Responses
CodeDescriptionSchema
201Update currency.Currency

/currencies/new

POST

Description

Create new currency.

Parameters
NameLocated inDescriptionRequiredSchema
nameformDataCurrency nameNostring
deposit_feeformDataCurrency deposit feeNodouble
min_deposit_amountformDataMinimal deposit amountNodouble
min_collection_amountformDataMinimal collection amount.Nodouble
withdraw_feeformDataCurrency withdraw feeNodouble
min_withdraw_amountformDataMinimal withdraw amountNodouble
withdraw_limit_24hformDataCurrency 24h withdraw limitNodouble
withdraw_limit_72hformDataCurrency 72h withdraw limitNodouble
positionformDataCurrency position.Nointeger
optionsformDataCurrency options.Nojson
visibleformDataCurrency display status (true/false).NoBoolean
deposit_enabledformDataCurrency deposit possibility status (true/false).NoBoolean
withdrawal_enabledformDataCurrency withdrawal possibility status (true/false).NoBoolean
precisionformDataCurrency precision.Nointeger
icon_urlformDataCurrency iconNostring
codeformDataUnique currency code.Yesstring
symbolformDataCurrency symbolYesstring
typeformDataCurrency typeNostring
base_factorformDataCurrency base factor.Nointeger
subunitsformDataFraction of the basic monetary unit.Nointeger
blockchain_keyformDataAssociated blockchain key which will perform transactions synchronization for currency.Yesstring
Responses
CodeDescriptionSchema
201Create new currency.Currency

/currencies/{code }

GET

Description

Get a currency.

Parameters
NameLocated inDescriptionRequiredSchema
codepathUnique currency code.Yesstring
Responses
CodeDescriptionSchema
200Get a currency.Currency

/currencies

GET

Description

Get list of currencies

Parameters
NameLocated inDescriptionRequiredSchema
blockchain_keyqueryAssociated blockchain key which will perform transactions synchronization for currency.Nostring
visiblequeryCurrency display status (true/false).NoBoolean
currencyqueryDeposit currency id.Nostring
typequeryCurrency typeNostring
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get list of currencies[ Currency ]

/markets/update

POST

Description

Update market.

Parameters
NameLocated inDescriptionRequiredSchema
amount_precisionformDataPrecision for order amount.Nointeger
price_precisionformDataPrecision for order price.Nointeger
max_priceformDataMaximum order price.Nodouble
positionformDataMarket position.Nointeger
dataformDataMarket additional data.Nojson
stateformDataMarket state defines if user can see/trade on current market.Nostring
idformDataUnique market id. It's always in the form of xxxyyy,where xxx is the base currency code, yyy is the quotecurrency code, e.g. 'btcusd'. All available markets canbe found at /api/v2/markets.Yesstring
min_priceformDataMinimum order price.Nodouble
min_amountformDataMinimum order amount.Nodouble
Responses
CodeDescriptionSchema
201Update market.Market

/markets/new

POST

Description

Create new market.

Parameters
NameLocated inDescriptionRequiredSchema
amount_precisionformDataPrecision for order amount.Nointeger
price_precisionformDataPrecision for order price.Nointeger
max_priceformDataMaximum order price.Nodouble
positionformDataMarket position.Nointeger
dataformDataMarket additional data.Nojson
stateformDataMarket state defines if user can see/trade on current market.Nostring
base_currencyformDataMarket Base unit.Yesstring
quote_currencyformDataMarket Quote unit.Yesstring
min_priceformDataMinimum order price.Yesdouble
min_amountformDataMinimum order amount.Yesdouble
Responses
CodeDescriptionSchema
201Create new market.Market

/markets/{id }

GET

Description

Get market.

Parameters
NameLocated inDescriptionRequiredSchema
idpathUnique market id. It's always in the form of xxxyyy,where xxx is the base currency code, yyy is the quotecurrency code, e.g. 'btcusd'. All available markets canbe found at /api/v2/markets.Yesstring
Responses
CodeDescriptionSchema
200Get market.Market

/markets

GET

Description

Get all markets, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
statequeryMarket stateNostring
base_unitqueryStrict filter for base unitNostring
quote_unitqueryStrict filter for quote unitNostring
unitqueryStrict filter for base or quote unitNostring
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all markets, result is paginated.[ Market ]

/wallets/update

POST

Description

Update wallet.

Parameters
NameLocated inDescriptionRequiredSchema
settingsformDataWallet settings.Nojson
max_balanceformDataWallet max balance.Nodouble
statusformDataWallet status (active/disabled).Nostring
idformDataUnique wallet identifier in database.Yesinteger
blockchain_keyformDataWallet blockchain key.Nostring
nameformDataWallet name.Nostring
addressformDataWallet address.Nostring
kindformDataKind of wallet 'deposit','fee','hot','warm' or 'cold'.Nostring
gatewayformDataWallet gateway.Nostring
currencyformDataWallet currency code.Nostring
Responses
CodeDescriptionSchema
201Update wallet.Wallet

/wallets/new

POST

Description

Creates new wallet.

Parameters
NameLocated inDescriptionRequiredSchema
settingsformDataWallet settings.Nojson
max_balanceformDataWallet max balance.Nodouble
statusformDataWallet status (active/disabled).Nostring
blockchain_keyformDataWallet blockchain key.Yesstring
nameformDataWallet name.Yesstring
addressformDataWallet address.Yesstring
currencyformDataWallet currency code.Yesstring
kindformDataKind of wallet 'deposit','fee','hot','warm' or 'cold'.Yesstring
gatewayformDataWallet gateway.Yesstring
Responses
CodeDescriptionSchema
201Creates new wallet.Wallet

/wallets/{id }

GET

Description

Get a wallet.

Parameters
NameLocated inDescriptionRequiredSchema
idpathUnique wallet identifier in database.Yesinteger
Responses
CodeDescriptionSchema
200Get a wallet.Wallet

/wallets/gateways

GET

Description

List wallet gateways.

Responses
CodeDescription
200List wallet gateways.

/wallets/kinds

GET

Description

List wallet kinds.

Responses
CodeDescription
200List wallet kinds.

/wallets

GET

Description

Get all wallets, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
blockchain_keyqueryWallet blockchain key.Nostring
kindqueryKind of wallet 'deposit','fee','hot','warm' or 'cold'.Nostring
gatewayqueryWallet gateway.Nostring
statusqueryWallet status (active/disabled).Nostring
currencyqueryDeposit currency id.Nostring
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all wallets, result is paginated.[ Wallet ]

/deposits/new

POST

Description

Creates new fiat deposit .

Parameters
NameLocated inDescriptionRequiredSchema
uidformDataDeposit member uid.Yesstring
currencyformDataDeposit currency id.Yesstring
amountformDataDeposit amount.Yesdouble
tidformDataDeposit tid.Nostring
Responses
CodeDescriptionSchema
201Creates new fiat deposit .Deposit

/deposits/actions

POST

Description

Take an action on the deposit.

Parameters
NameLocated inDescriptionRequiredSchema
idformDataUnique deposit id.Yesinteger
actionformDataValid actions are [:cancel, :reject, :accept, :skip, :dispatch].Yesstring
Responses
CodeDescriptionSchema
201Take an action on the deposit.Deposit

/deposits

GET

Description

Get all deposits, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
statequeryDeposit state.Nostring
idqueryUnique deposit id.Nointeger
txidqueryDeposit transaction id.Nostring
addressqueryDeposit blockchain address.Nostring
tidqueryDeposit tid.Nostring
uidqueryMember UID.Nostring
currencyqueryDeposit currency id.Nostring
typequeryCurrency typeNostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all deposits, result is paginated.[ Deposit ]

/withdraws/actions

POST

Description

Take an action on the withdrawal.

Parameters
NameLocated inDescriptionRequiredSchema
idformDataThe withdrawal id.Yesinteger
actionformDataValid actions are [:submit, :cancel, :accept, :reject, :process, :load, :dispatch, :success, :skip, :fail, :err].Yesstring
txidformDataThe withdrawal transaction id.Nostring
Responses
CodeDescriptionSchema
201Take an action on the withdrawal.Withdraw

/withdraws/{id }

GET

Description

Get withdraw by ID.

Parameters
NameLocated inDescriptionRequiredSchema
idpathThe withdrawal id.Yesinteger
Responses
CodeDescriptionSchema
200Get withdraw by ID.Withdraw

/withdraws

GET

Description

Get all withdraws, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
statequeryThe withdrawal state.Nostring
idqueryThe withdrawal id.Nointeger
txidqueryThe withdrawal transaction id.Nostring
tidqueryWithdraw tid.Nostring
confirmationsqueryNumber of confirmations.Nointeger
ridqueryThe beneficiary ID or wallet address on the Blockchain.Nostring
uidqueryMember UID.Nostring
currencyqueryDeposit currency id.Nostring
typequeryCurrency typeNostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all withdraws, result is paginated.[ Withdraw ]

/trades/{id }

GET

Description

Get a trade with detailed information.

Parameters
NameLocated inDescriptionRequiredSchema
idpathTrade ID.Yesinteger
Responses
CodeDescriptionSchema
200Get a trade with detailed information.Blockchain

/trades

GET

Description

Get all trades, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
marketqueryUnique market id. It's always in the form of xxxyyy,where xxx is the base currency code, yyy is the quotecurrency code, e.g. 'btcusd'. All available markets canbe found at /api/v2/markets.Nostring
order_idqueryUnique order id.Nointeger
uidqueryMember UID.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all trades, result is paginated.[ Trade ]

/assets

GET

Description

Returns assets as a paginated collection.

Parameters
NameLocated inDescriptionRequiredSchema
reference_typequeryThe reference type for which operation was created.Nostring
ridqueryThe unique id of operation's reference, for which operation was created.Nointeger
codequeryOpeartion's code.Nointeger
currencyqueryDeposit currency id.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Returns assets as a paginated collection.Operation

/expenses

GET

Description

Returns expenses as a paginated collection.

Parameters
NameLocated inDescriptionRequiredSchema
reference_typequeryThe reference type for which operation was created.Nostring
ridqueryThe unique id of operation's reference, for which operation was created.Nointeger
codequeryOpeartion's code.Nointeger
currencyqueryDeposit currency id.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Returns expenses as a paginated collection.Operation

/revenues

GET

Description

Returns revenues as a paginated collection.

Parameters
NameLocated inDescriptionRequiredSchema
reference_typequeryThe reference type for which operation was created.Nostring
ridqueryThe unique id of operation's reference, for which operation was created.Nointeger
codequeryOpeartion's code.Nointeger
currencyqueryDeposit currency id.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Returns revenues as a paginated collection.Operation

/liabilities

GET

Description

Returns liabilities as a paginated collection.

Parameters
NameLocated inDescriptionRequiredSchema
uidqueryMember UID.Nostring
reference_typequeryThe reference type for which operation was created.Nostring
ridqueryThe unique id of operation's reference, for which operation was created.Nointeger
codequeryOpeartion's code.Nointeger
currencyqueryDeposit currency id.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Returns liabilities as a paginated collection.Operation

/members/{uid }

PUT

Description

Set user group.

Parameters
NameLocated inDescriptionRequiredSchema
uidpathThe shared user ID.Yesstring
groupformDataUser gruopYesstring
Responses
CodeDescriptionSchema
200Set user group.Member

GET

Description

Get a member.

Parameters
NameLocated inDescriptionRequiredSchema
uidpathThe shared user ID.Yesstring
Responses
CodeDescriptionSchema
200Get a member.Member

/members/groups

GET

Description

Get available members groups.

Responses
CodeDescription
200Get available members groups.

/members

GET

Description

Get all members, result is paginated.

Parameters
NameLocated inDescriptionRequiredSchema
statequeryFilter order by state.Nostring
rolequeryNostring
groupqueryNostring
emailqueryMember email.Nostring
uidqueryMember UID.Nostring
rangequeryDate range picker, defaults to 'created'.Nostring
fromqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities FROM the time will be retrieved.NodateTime
toqueryAn integer represents the seconds elapsed since Unix epoch.If set, only entities BEFORE the time will be retrieved.NodateTime
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Get all members, result is paginated.[ Member ]

/trading_fees/delete

POST

Description

It deletes trading fees record

Parameters
NameLocated inDescriptionRequiredSchema
idformDataUnique trading fee table identifier in database.Yesinteger
Responses
CodeDescriptionSchema
201It deletes trading fees recordTradingFee

/trading_fees/update

POST

Description

It updates trading fees record

Parameters
NameLocated inDescriptionRequiredSchema
idformDataUnique trading fee table identifier in database.Yesinteger
makerformDataMarket maker fee.Nodouble
takerformDataMarket taker fee.Nodouble
groupformDataMember group for define maker/taker fee.Nostring
market_idformDataMarket id for define maker/taker fee.Nostring
Responses
CodeDescriptionSchema
201It updates trading fees recordTradingFee

/trading_fees/new

POST

Description

It creates trading fees record

Parameters
NameLocated inDescriptionRequiredSchema
makerformDataMarket maker fee.Yesdouble
takerformDataMarket taker fee.Yesdouble
groupformDataMember group for define maker/taker fee.Nostring
market_idformDataMarket id for define maker/taker fee.Nostring
Responses
CodeDescriptionSchema
201It creates trading fees recordTradingFee

/trading_fees

GET

Description

Returns trading_fees table as paginated collection

Parameters
NameLocated inDescriptionRequiredSchema
groupqueryMember group for define maker/taker fee.Nostring
market_idqueryMarket id for define maker/taker fee.Nostring
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
Responses
CodeDescriptionSchema
200Returns trading_fees table as paginated collection[ TradingFee ]

Models

Adjustment

Get all adjustments, result is paginated.

NameTypeDescriptionRequired
idintegerUnique adjustment identifier in database.No
reasonstringAdjustment reason.No
descriptionstringAdjustment description.No
categorystringAdjustment categoryNo
amountstringAdjustment amount.No
validator_uidintegerUnique adjustment validator identifier in database.No
creator_uidintegerUnique adjustment creator identifier in database.No
currencystringAdjustment currency ID.No
assetOperationNo
liabilityOperationNo
revenueOperationNo
expenseOperationNo
statestringAdjustment's state.No
asset_account_codeintegerAdjustment asset account code.No
receiving_account_codestringAdjustment receiving account code.No
receiving_member_uidstringAdjustment receiving member uid.No
created_atstringThe datetime when operation was created.No
updated_atstringThe datetime when operation was updated.No

Operation

Returns liabilities as a paginated collection.

NameTypeDescriptionRequired
idintegerUnique operation identifier in database.No
codestringThe Account code which this operation related to.No
currencystringOperation currency ID.No
creditstringOperation credit amount.No
debitstringOperation debit amount.No
uidstringThe shared user ID.No
account_kindstringOperation's account kind (locked or main).No
ridstringThe id of operation reference.No
reference_typestringThe type of operations.No
created_atstringThe datetime when operation was created.No

Order

Get all orders, result is paginated.

NameTypeDescriptionRequired
idintegerUnique order id.No
uuidstringUnique order UUID.No
sidestringEither 'sell' or 'buy'.No
ord_typestringType of order, either 'limit' or 'market'.No
pricedoublePrice for each unit. e.g.If you want to sell/buy 1 btc at 3000 usd, the price is '3000.0'No
avg_pricedoubleAverage execution price, average of price in trades.No
statestringOne of 'wait', 'done', or 'cancel'.An order in 'wait' is an active order, waiting fulfillment;a 'done' order is an order fulfilled;'cancel' means the order has been canceled.No
marketstringThe market in which the order is placed, e.g. 'btcusd'.All available markets can be found at /api/v2/markets.No
created_atstringOrder create time in iso8601 format.No
updated_atstringOrder updated time in iso8601 format.No
origin_volumedoubleThe amount user want to sell/buy.An order could be partially executed,e.g. an order sell 5 btc can be matched with a buy 3 btc order,left 2 btc to be sold; in this case the order's volume would be '5.0',its remaining_volume would be '2.0', its executed volume is '3.0'.No
remaining_volumedoubleThe remaining volume, see 'volume'.No
executed_volumedoubleThe executed volume, see 'volume'.No
trades_countintegerCount of trades.No
emailstringThe shared user email.No
uidstringThe shared user ID.No

Blockchain

Get a trade with detailed information.

NameTypeDescriptionRequired
idintegerUnique blockchain identifier in database.No
keystringUnique key to identify blockchain.No
namestringA name to identify blockchain.No
clientstringIntegrated blockchain client.No
serverstringBlockchain server url.No
heightintegerThe number of blocks preceding a particular block on blockchain.No
explorer_addressstringBlockchain explorer address template.No
explorer_transactionstringBlockchain explorer transaction template.No
min_confirmationsintegerMinimum number of confirmations.No
statusstringBlockchain status (active/disabled).No
created_atstringBlockchain created time in iso8601 format.No
updated_atstringBlockchain updated time in iso8601 format.No

Currency

Get list of currencies

NameTypeDescriptionRequired
namestringCurrency name
Example: "Bitcoin"
No
symbolstringCurrency symbol
Example: "฿"
No
explorer_transactionstringCurrency transaction exprorer url template
Example: "https://testnet.blockchain.info/tx/"
No
explorer_addressstringCurrency address exprorer url template
Example: "https://testnet.blockchain.info/address/"
No
typestringCurrency type
Example: "coin"
No
deposit_enabledstringCurrency deposit possibility status (true/false).No
withdrawal_enabledstringCurrency withdrawal possibility status (true/false).No
deposit_feestringCurrency deposit fee
Example: "0.0"
No
min_deposit_amountstringMinimal deposit amount
Example: "0.0000356"
No
withdraw_feestringCurrency withdraw fee
Example: "0.0"
No
min_withdraw_amountstringMinimal withdraw amount
Example: "0.0"
No
withdraw_limit_24hstringCurrency 24h withdraw limit
Example: "0.1"
No
withdraw_limit_72hstringCurrency 72h withdraw limit
Example: "0.2"
No
base_factorintegerCurrency base factor.No
precisionintegerCurrency precision.No
positionintegerCurrency position.No
icon_urlstringCurrency icon
Example: "https://upload.wikimedia.org/wikipedia/commons/0/05/Ethereum_logo_2014.svg"
No
min_confirmationsstringNumber of confirmations required for confirming deposit or withdrawalNo
codestringUnique currency code.No
blockchain_keystringAssociated blockchain key which will perform transactions synchronization for currency.No
min_collection_amountdoubleMinimal collection amount.No
visiblestringCurrency display status (true/false).No
subunitsintegerFraction of the basic monetary unit.No
optionsjsonCurrency options.No
created_atstringCurrency created time in iso8601 format.No
updated_atstringCurrency updated time in iso8601 format.No

Market

Get all markets, result is paginated.

NameTypeDescriptionRequired
idstringUnique market id. It's always in the form of xxxyyy,where xxx is the base currency code, yyy is the quotecurrency code, e.g. 'btcusd'. All available markets canbe found at /api/v2/markets.No
namestringMarket name.No
base_unitstringMarket Base unit.No
quote_unitstringMarket Quote unit.No
min_pricedoubleMinimum order price.No
max_pricedoubleMaximum order price.No
min_amountdoubleMinimum order amount.No
amount_precisiondoublePrecision for order amount.No
price_precisiondoublePrecision for order price.No
statestringMarket state defines if user can see/trade on current market.No
positionintegerMarket position.No
datajsonMarket additional data.No
created_atstringMarket created time in iso8601 format.No
updated_atstringMarket updated time in iso8601 format.No

Wallet

Get all wallets, result is paginated.

NameTypeDescriptionRequired
idintegerUnique wallet identifier in database.No
namestringWallet name.No
kindstringKind of wallet 'deposit','fee','hot','warm' or 'cold'.No
currencystringWallet currency code.No
addressstringWallet address.No
gatewaystringWallet gateway.No
max_balancedoubleWallet max balance.No
blockchain_keystringWallet blockchain key.No
statusstringWallet status (active/disabled).No
settingsjsonWallet settings.No
created_atstringWallet created time in iso8601 format.No
updated_atstringWallet updated time in iso8601 format.No

Deposit

Get all deposits, result is paginated.

NameTypeDescriptionRequired
idintegerUnique deposit id.No
currencystringDeposit currency id.No
amountdoubleDeposit amount.No
feedoubleDeposit fee.No
txidstringDeposit transaction id.No
confirmationsintegerNumber of deposit confirmations.No
statestringDeposit state.No
created_atstringThe datetime when deposit was created.No
completed_atstringThe datetime when deposit was completed.No
tidstringDeposit tid.No
memberstringThe member id.No
uidstringDeposit member uid.No
emailstringThe deposit member email.No
addressstringDeposit blockchain address.No
txoutintegerDeposit blockchain transaction output.No
block_numberintegerDeposit blockchain block number.No
typestringDeposit type (fiat or coin).No
spreadstringDeposit collection spread.No
updated_atstringThe datetime when deposit was updated.No

Withdraw

Get all withdraws, result is paginated.

NameTypeDescriptionRequired
idintegerThe withdrawal id.No
currencystringThe currency code.No
typestringThe withdrawal typeNo
sumdoubleThe withdrawal sum.No
feedoubleThe exchange fee.No
blockchain_txidstringThe withdrawal transaction id.No
ridstringThe beneficiary ID or wallet address on the Blockchain.No
statestringThe withdrawal state.No
confirmationsintegerNumber of confirmations.No
notestringWithdraw note.No
created_atstringThe datetimes for the withdrawal.No
updated_atstringThe datetimes for the withdrawal.No
completed_atstringThe datetime when withdraw was completed.No
memberstringThe member id.No
beneficiaryBeneficiaryNo
uidstringThe withdrawal member uid.No
emailstringThe withdrawal member email.No
accountstringThe account code.No
block_numberintegerThe withdrawal block_number.No
amountdoubleThe withdrawal amount.No
tidstringWithdraw tid.No

Beneficiary

NameTypeDescriptionRequired
idintegerBeneficiary Identifier in DatabaseNo
currencystringBeneficiary currency code.No
namestringHuman rememberable name which refer beneficiary.No
descriptionstringHuman rememberable description of beneficiary.No
datajsonBank Account details for fiat Beneficiary in JSON format.For crypto it's blockchain address.No
statestringDefines either beneficiary active - user can use it to withdraw moneyor pending - requires beneficiary activation with pin.No
sent_atstringTime when last pin was sentNo

Trade

Get all trades, result is paginated.

NameTypeDescriptionRequired
idstringTrade ID.No
pricedoubleTrade price.No
amountdoubleTrade amount.No
totaldoubleTrade total (Amount * Price).No
marketstringTrade market id.No
created_atstringTrade create time in iso8601 format.No
taker_typestringTrade taker order type (sell or buy).No
maker_order_emailstringTrade maker member email.No
maker_uidstringTrade maker member uid.No
maker_feedoubleTrade maker fee percentage.No
maker_fee_amountdoubleTrade maker fee amount.No
maker_fee_currencystringTrade maker fee currency code.No
maker_orderOrderNo
taker_order_emailstringTrade taker member email.No
taker_uidstringTrade taker member uid.No
taker_fee_currencystringTrade taker fee currency code.No
taker_feedoubleTrade taker fee percentage.No
taker_fee_amountdoubleTrade taker fee amount.No
taker_orderOrderNo

Member

Get all members, result is paginated.

NameTypeDescriptionRequired
uidstringMember UID.No
emailstringMember email.No
accounts[ Account ]Member accounts.No
idintegerUnique member identifier in database.No
levelintegerMember's level.No
rolestringMember's role.No
groupstringMember's group.No
statestringMember's state.No
created_atstringMember created time in iso8601 format.No
updated_atstringMember updated time in iso8601 format.No

Account

NameTypeDescriptionRequired
currencystringCurrency code.No
balancedoubleAccount balance.No
lockeddoubleAccount locked funds.No

TradingFee

Returns trading_fees table as paginated collection

NameTypeDescriptionRequired
idintegerUnique trading fee table identifier in database.No
groupstringMember group for define maker/taker fee.No
market_idstringMarket id for define maker/taker fee.No
makerdoubleMarket maker fee.No
takerdoubleMarket taker fee.No
created_atstringTrading fee table created time in iso8601 format.No
updated_atstringTrading fee table updated time in iso8601 format.No