Peatio Management API v2

Management API is server-to-server API with high privileges.

Version: 2.2.31

Contact information:
peatio.tech
https://www.peatio.tech
hello@peatio.tech

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

/accounts/balance

POST

Description:

Queries the account balance for the given UID and currency.

Parameters
Name Located in Description Required Schema
uid formData The shared user ID. Yes string
currency formData The currency code. Yes string
Responses
Code Description Schema
201 Queries the account balance for the given UID and currency. Balance

/deposits/state

PUT

Description:

Allows to load money or cancel deposit.

Parameters
Name Located in Description Required Schema
tid formData The shared transaction ID. Yes string
state formData The new state to apply. Yes string
Responses
Code Description Schema
200 Allows to load money or cancel deposit. Deposit

/deposits/new

POST

Description:

Creates new fiat deposit with state set to «submitted». Optionally pass field «state» set to «accepted» if want to load money instantly. You can also use PUT /fiat_deposits/:id later to load money or cancel deposit.

Parameters
Name Located in Description Required Schema
uid formData The shared user ID. Yes string
tid formData The shared transaction ID. Must not exceed 64 characters. Peatio will generate one automatically unless supplied. No string
currency formData The currency code. Yes string
amount formData The deposit amount. Yes double
state formData The state of deposit. No string
Responses
Code Description Schema
201 Creates new fiat deposit with state set to «submitted». Optionally pass field «state» set to «accepted» if want to load money instantly. You can also use PUT /fiat_deposits/:id later to load money or cancel deposit. Deposit

/deposits/get

POST

Description:

Returns deposit by TID.

Parameters
Name Located in Description Required Schema
tid formData The transaction ID. Yes string
Responses
Code Description Schema
201 Returns deposit by TID. Deposit

/deposits

POST

Description:

Returns deposits as paginated collection.

Parameters
Name Located in Description Required Schema
uid formData The shared user ID. No string
currency formData The currency code. No string
page formData The page number (defaults to 1). No integer
limit formData The number of deposits per page (defaults to 100, maximum is 1000). No integer
state formData The state to filter by. No string
Responses
Code Description Schema
201 Returns deposits as paginated collection. Deposit

/withdraws/action

PUT

Summary:

Performs action on withdraw.

Description:

«process» – system will lock the money, check for suspected activity, validate recipient address, and initiate the processing of the withdraw. «cancel» – system will mark withdraw as «canceled», and unlock the money.

Parameters
Name Located in Description Required Schema
tid formData The shared transaction ID. Yes string
action formData The action to perform. Yes string
Responses
Code Description Schema
200 Performs action on withdraw. Withdraw

/withdraws/new

POST

Summary:

Creates new withdraw.

Description:

Creates new withdraw. The behaviours for fiat and crypto withdraws are different. Fiat: money are immediately locked, withdraw state is set to «submitted», system workers will validate withdraw later against suspected activity, and assign state to «rejected» or «accepted». The processing will not begin automatically. The processing may be initiated manually from admin panel or by PUT /management_api/v1/withdraws/action. Coin: money are immediately locked, withdraw state is set to «submitted», system workers will validate withdraw later against suspected activity, validate withdraw address and

Parameters
Name Located in Description Required Schema
uid formData The shared user ID. Yes string
tid formData The shared transaction ID. Must not exceed 64 characters. Peatio will generate one automatically unless supplied. No string
rid formData The beneficiary ID or wallet address on the Blockchain. Yes string
currency formData The currency code. Yes string
amount formData The amount to withdraw. Yes double
action formData The action to perform. No string
Responses
Code Description Schema
201 Creates new withdraw. Withdraw

/withdraws/get

POST

Description:

Returns withdraw by ID.

Parameters
Name Located in Description Required Schema
tid formData The shared transaction ID. Yes string
Responses
Code Description Schema
201 Returns withdraw by ID. Withdraw

/withdraws

POST

Description:

Returns withdraws as paginated collection.

Parameters
Name Located in Description Required Schema
uid formData The shared user ID. No string
currency formData The currency code. No string
page formData The page number (defaults to 1). No integer
limit formData The number of objects per page (defaults to 100, maximum is 1000). No integer
state formData The state to filter by. No string
Responses
Code Description Schema
201 Returns withdraws as paginated collection. Withdraw

/timestamp

POST

Description:

Returns server time in seconds since Unix epoch.

Responses
Code Description
201 Returns server time in seconds since Unix epoch.

/assets/new

POST

Description:

Creates new asset operation.

Parameters
Name Located in Description Required Schema
currency formData The currency code. Yes string
code formData Operation account code Yes integer
debit formData Operation debit amount. No double
credit formData Operation credit amount. No double
Responses
Code Description Schema
201 Creates new asset operation. Operation

/assets

POST

Description:

Returns assets as paginated collection.

Parameters
Name Located in Description Required Schema
currency formData The currency for operations filtering. No string
page formData The page number (defaults to 1). No integer
limit formData The number of objects per page (defaults to 100, maximum is 1000). No integer
time_from formData An integer represents the seconds elapsed since Unix epoch.If set, only operations after the time will be returned. No integer
time_to formData An integer represents the seconds elapsed since Unix epoch.If set, only operations before the time will be returned. No integer
reference_type formData The reference type for operations filtering No string
Responses
Code Description Schema
201 Returns assets as paginated collection. Operation

/expenses/new

POST

Description:

Creates new expense operation.

Parameters
Name Located in Description Required Schema
currency formData The currency code. Yes string
code formData Operation account code Yes integer
debit formData Operation debit amount. No double
credit formData Operation credit amount. No double
Responses
Code Description Schema
201 Creates new expense operation. Operation

/expenses

POST

Description:

Returns expenses as paginated collection.

Parameters
Name Located in Description Required Schema
currency formData The currency for operations filtering. No string
page formData The page number (defaults to 1). No integer
limit formData The number of objects per page (defaults to 100, maximum is 1000). No integer
time_from formData An integer represents the seconds elapsed since Unix epoch.If set, only operations after the time will be returned. No integer
time_to formData An integer represents the seconds elapsed since Unix epoch.If set, only operations before the time will be returned. No integer
reference_type formData The reference type for operations filtering No string
Responses
Code Description Schema
201 Returns expenses as paginated collection. Operation

/revenues/new

POST

Description:

Creates new revenue operation.

Parameters
Name Located in Description Required Schema
currency formData The currency code. Yes string
code formData Operation account code Yes integer
debit formData Operation debit amount. No double
credit formData Operation credit amount. No double
Responses
Code Description Schema
201 Creates new revenue operation. Operation

/revenues

POST

Description:

Returns revenues as paginated collection.

Parameters
Name Located in Description Required Schema
currency formData The currency for operations filtering. No string
page formData The page number (defaults to 1). No integer
limit formData The number of objects per page (defaults to 100, maximum is 1000). No integer
time_from formData An integer represents the seconds elapsed since Unix epoch.If set, only operations after the time will be returned. No integer
time_to formData An integer represents the seconds elapsed since Unix epoch.If set, only operations before the time will be returned. No integer
reference_type formData The reference type for operations filtering No string
Responses
Code Description Schema
201 Returns revenues as paginated collection. Operation

/liabilities/new

POST

Description:

Creates new liability operation.

Parameters
Name Located in Description Required Schema
currency formData The currency code. Yes string
code formData Operation account code Yes integer
uid formData The user ID for operation owner. Yes string
debit formData Operation debit amount. No double
credit formData Operation credit amount. No double
Responses
Code Description Schema
201 Creates new liability operation. Operation

/liabilities

POST

Description:

Returns liabilities as paginated collection.

Parameters
Name Located in Description Required Schema
currency formData The currency for operations filtering. No string
uid formData The user ID for operations filtering. No string
reference_type formData The reference type for operations filtering No string
time_from formData An integer represents the seconds elapsed since Unix epoch.If set, only operations after the time will be returned. No integer
time_to formData An integer represents the seconds elapsed since Unix epoch.If set, only operations before the time will be returned. No integer
page formData The page number (defaults to 1). No integer
limit formData The number of objects per page (defaults to 100, maximum is 10000). No integer
Responses
Code Description Schema
201 Returns liabilities as paginated collection. Operation

/transfers/new

POST

Description:

Creates new transfer.

Parameters
Name Located in Description Required Schema
key formData Unique Transfer Key. Yes integer
kind formData Transfer Kind. Yes string
desc formData Transfer Description. No string
operations[currency] formData Operation currency. Yes [ string ]
operations[amount] formData Operation amount. Yes [ double ]
operations[account_src][code] formData Source Account code. Yes [ integer ]
operations[account_src][uid] formData Source Account User ID (for accounts with member scope). Yes [ string ]
operations[account_dst][code] formData Destination Account code. Yes [ integer ]
operations[account_dst][uid] formData Destination Account User ID (for accounts with member scope). Yes [ string ]
Responses
Code Description
201 Creates new transfer.

/trades

POST

Description:

Returns trades as paginated collection.

Parameters
Name Located in Description Required Schema
uid formData The shared user ID. No string
market formData No string
page formData The page number (defaults to 1). No integer
limit formData The number of objects per page (defaults to 100, maximum is 1000). No integer
Responses
Code Description Schema
201 Returns trades as paginated collection. Trade

Models

Balance

Queries the account balance for the given UID and currency.

Name Type Description Required
uid string The shared user ID. No
balance string The account balance. No
locked string The locked account balance. No

Deposit

Returns deposits as paginated collection.

Name Type Description Required
tid integer The shared transaction ID. No
currency string The currency code. No
uid string The shared user ID. No
type string The deposit type (fiat or coin). No
amount string The deposit amount. No
state string The deposit state. «submitted» – initial state. «canceled» – deposit has been canceled by outer service. «rejected» – deposit has been rejected by outer service.. «accepted» – deposit has been accepted by outer service, money are loaded. No
created_at string The datetime when deposit was created. No
completed_at string The datetime when deposit was completed. No
blockchain_txid string The transaction ID on the Blockchain (coin only). No
blockchain_confirmations string The number of transaction confirmations on the Blockchain (coin only). No

Withdraw

Returns withdraws as paginated collection.

Name Type Description Required
tid integer The shared transaction ID. No
uid string The shared user ID. No
currency string The currency code. No
type string The withdraw type (fiat or coin). No
amount string The withdraw amount excluding fee. No
fee string The exchange fee. No
rid string The beneficiary ID or wallet address on the Blockchain. No
state string The withdraw state. «prepared» – initial state, money are not locked. «submitted» – withdraw has been allowed by outer service for further validation, money are locked. «canceled» – withdraw has been canceled by outer service, money are unlocked. «accepted» – system has validated withdraw and queued it for processing by worker, money are locked. «rejected» – system has validated withdraw and found errors, money are unlocked. «processing» – worker is processing withdraw as the current moment, money are locked. «skipped» – worker skipped withdrawal in case of insufficient balance of hot wallet or it absence. «succeed» – worker has successfully processed withdraw, money are subtracted from the account. «failed» – worker has encountered an unhandled error while processing withdraw, money are unlocked. No
created_at string The datetime when withdraw was created. No
blockchain_txid string The transaction ID on the Blockchain (coin only). No

Operation

Returns liabilities as paginated collection.

Name Type Description Required
code string The Account code which this operation related to. No
currency string Operation currency ID. No
credit string Operation credit amount. No
debit string Operation debit amount. No
uid string The shared user ID. No
reference_type string The type of operations. No
created_at string The datetime when operation was created. No

Trade

Returns trades as paginated collection.

Name Type Description Required
id string Trade ID. No
price double Trade price. No
volume double Trade volume. No
funds double Trade funds. No
market string Trade market id. No
created_at string Trade create time in iso8601 format. No
ask_id string Trade ask order id. No
bid_id string Trade bid order id. No
ask_member_uid string Trade ask member uid. No
bid_member_uid string Trade bid member uid. No
taker_type string Trade maker order type (sell or buy). No
side string Trade side. No
order_id integer Order id. No