Accounts
Account Information
- GET
https://api.poloniex.com/accounts
Get a list of all accounts of a user.
Response Field | Data Type | Description |
---|---|---|
accountId | String | account ID |
accountType | String | account type. Currently only SPOT is supported |
accountState | String | account's state, e.g. NORMAL, LOCKED |
Example output:
[
{
"accountId": "123",
"accountType": "SPOT",
"accountState": "NORMAL"
}
]
All Account Balances
- GET
https://api.poloniex.com/accounts/balances
- GET
https://api.poloniex.com/accounts/{id}/balances
/accounts/balances
: get a list of all accounts of a user with each account’s id, type and balances (assets).
Request Parameter | Data Type | Required | Description |
---|---|---|---|
accountType | String | false | The account type. e.g. SPOT. Default will show all account types if not specified. Currently only SPOT is supported |
Response Field | Data Type | Description |
---|---|---|
accountId | String | account ID |
accountType | String | account type. Currently, SPOT is the only supported one. |
balances | Json | account's assets |
Balances Field | Data Type | Description |
---|---|---|
currencyId | String | currency id |
currency | String | currency name |
available | String | available amount for the currency. can be negative due to margin |
hold | String | frozen amount for the currency |
Example output:
[
{
"accountId": "123",
"accountType": "SPOT",
"balances": [
{
"currencyId": "60001",
"currency": "TRX",
"available": "93640.421767943475",
"hold": "19.84382885"
},
{
"currencyId": "60002",
"currency": "ELON",
"available": "100037.9449",
"hold": "0.00"
},
{
"currencyId": "60003",
"currency": "USDC",
"available": "78086.768609427831705",
"hold": "22577.045"
}
]
}
]
/accounts/{id}/balances
: get the full details for a single account with its balances: free (available) and locked (hold) for each currency.
Request Parameter | Data Type | Required | Description |
---|---|---|---|
id | Long | true | account id, data from /accounts |
Response fields and balances fields are the same as those of /accounts/balances
.
Account Activity
- GET
https://api.poloniex.com/accounts/activity
Get a list of activities such as airdrop, rebates, staking, credit/debit adjustments, and other (historical adjustments).
Request Parameter | Data Type | Required | Description |
---|---|---|---|
startTime | Long | false | (milliseconds since UNIX epoch) trades filled before startTime will not be retrieved. |
endTime | Long | false | (milliseconds since UNIX epoch) trades filled after endTime will not be retrieved. |
activityType | Integer | false | Type of activity: ALL: 200, AIRDROP: 201, COMMISSION_REBATE: 202, STAKING: 203, REFERAL_REBATE: 204, CREDIT_ADJUSTMENT: 104, DEBIT_ADJUSTMENT: 105, OTHER: 199 |
limit | Integer | false | The max number of records could be returned. Default is 100 and max is 1000. |
from | Long | false | It is 'id'. The query begin at ‘from', and the default is 0. |
direction | String | false | PRE, NEXT, default is NEXT |
currency | String | false | The transferred currency, like USDT. Default is for all currencies, if not specified. |
Response Field | Data Type | Description |
---|---|---|
id | String | activity id |
currency | String | currency like BTC, ETH etc |
amount | String | amount of the activity (can be negative) |
state | String | state of the activity e.g. SUCCESS, PROCESSSING, FAILED |
createTime | Long | datetime of the activity |
description | String | activity details |
activityType | Integer | type of activity |
Example output:
[
{
"id": "22774050",
"currency": "LINK",
"amount": "100000000",
"state": "SUCCESS",
"createTime": 1659781580499,
"description": "Your airdrop for 100000000 LINK",
"activityType": 200
},
{
"id": "22774049",
"currency": "ADA",
"amount": "100000000",
"state": "SUCCESS",
"createTime": 1659781579899,
"description": "Your airdrop for 100000000 ADA",
"activityType": 200
}
]
Accounts Transfer
- POST
https://api.poloniex.com/accounts/transfer
Transfer amount of currency from an account to another account for a user.
Request Parameter | Data Type | Required | Description |
---|---|---|---|
currency | String | true | The currency to transfer, like USDT |
amount | String | true | The amount to transfer. |
fromAccount | String | true | The account, from which the currency is transferred. |
toAccount | String | true | The account, to which the currency is transferred. |
Example request:
{
"currency": "USDT",
"amount": "10.5",
"fromAccount": "SPOT",
"toAccount": "FUTURES"
}
Response Field | Data Type | Description |
---|---|---|
transferId | String | transfer ID |
Example output:
{
"transferId": "2977"
}
Accounts Transfer Records
- GET
https://api.poloniex.com/accounts/transfer
- GET
https://api.poloniex.com/accounts/transfer/{id}
Get a list of transfer records of a user. Max interval for start and end time is 6 months. If no start/end time params are specified then records for last 7 days will be returned.
Request Parameter | Data Type | Required | Description |
---|---|---|---|
limit | Integer | false | The max number of records could be returned. Default is 100 and max is 1000 records. |
from | Long | false | it is 'transferId'. The query begin at ‘from', and the default is 0. |
direction | String | false | PRE, NEXT, default is NEXT |
currency | String | false | The transferred currency, like USDT. Default is for all currencies, if not specified. |
startTime | Long | false | (milliseconds since UNIX epoch) transfers before start time will not be retrieved. |
endTime | Long | false | (milliseconds since UNIX epoch) transfers after end time will not be retrieved. |
Response Field | Data Type | Description |
---|---|---|
id | String | transfer ID |
fromAccount | String | the account, from which the currency is transferred. |
toAccount | String | the account, to which the currency is transferred. |
currency | String | the transferred currency |
amount | String | the transferred amount |
state | String | the state of transfer operation. e.g. SUCCESS, PROCESSSING, FAILED |
createTime | Long | the datetime of transfer operation |
Example output:
[
{
"id": "23365",
"fromAccount": "SPOT",
"toAccount": "FUTURES",
"currency": "USDT",
"amount": "0.01",
"state": "SUCCESS",
"createTime": 1656000618690
},
{
"id": "532",
"fromAccount": "SPOT",
"toAccount": "FUTURES",
"currency": "USDT",
"amount": "1.2",
"state": "SUCCESS",
"createTime": 1650843791635
},
{
"id": "147",
"fromAccount": "FUTURES",
"toAccount": "SPOT",
"currency": "ETH",
"amount": "2.05",
"state": "SUCCESS",
"createTime": 1650465162165
}
]
Get a single transfer record corresponding to the transferId.
Request Parameter | Data Type | Required | Description |
---|---|---|---|
id | Long | true | transfer ID |
Response fields are the same as those of /accounts/transfer
.
Example output:
{
"id": "46170",
"fromAccount": "SPOT",
"toAccount": "FUTURES",
"currency": "USDT",
"amount": "0.01",
"state": "SUCCESS",
"createTime": 1657112840949
}
Fee Info
- GET
https://api.poloniex.com/feeinfo
Get fee rate for an account
Response Field | Data Type | Description |
---|---|---|
trxDiscount | Boolean | Discount exists if using TRX |
makerRate | String | Maker rate |
takerRate | String | Taker rate |
volume30D | String | 30 days volume in USDT |
specialFeeRates | Json Array | Custom fee rates for symbols |
Response Field | Data Type | Description |
---|---|---|
symbol | String | symbol name |
makerRate | String | Maker rate |
takerRate | String | Taker rate |
Example output:
{
"trxDiscount": true,
"makerRate": "0.000234",
"takerRate": "0.000189",
"volume30D": "0.0000550",
"specialFeeRates": [
{
"symbol": "USDD_USDT",
"makerRate": "0.00",
"takerRate": "0.00"
},
{
"symbol": "LSK_BTC",
"makerRate": "0.02",
"takerRate": "0.01"
}
]
}
Interest History
- GET
https://api.poloniex.com/accounts/interest/history
Get a list of interest collection records of a user. Max interval for start and end time is 90 days. If no start/end time params are specified then records for last 7 days will be returned.
Request Parameter | Data Type | Required | Description |
---|---|---|---|
limit | Integer | false | The max number of records could be returned. Default is 10 and max is 100 records. |
from | Long | false | it is 'id'. The query begin at ‘from', and the default is 0. |
direction | String | false | PRE, NEXT, default is NEXT |
startTime | Long | false | (milliseconds since UNIX epoch) records before start time will not be retrieved. |
endTime | Long | false | (milliseconds since UNIX epoch) records after end time will not be retrieved. |
Response Field | Data Type | Description |
---|---|---|
id | String | record ID |
interestAccuredTime | Long | Interest collection time. |
currencyName | String | Asset name. |
principal | String | Principal. |
interest | String | interest. |
interestRate | String | interest rate. |
Example output:
[
{
"id": "1",
"currencyName": "USDT",
"principal": "100.00",
"interest": "0.001",
"interestRate": "0.00001",
"interestAccuredTime": 1656000618690
},
{
"id": "3",
"currencyName": "BTC",
"principal": "1000.00",
"interest": "0.01",
"interestRate": "0.00001",
"interestAccuredTime": 1650843791635
},
{
"id": "9",
"currencyName": "ETH",
"principal": "10000.00",
"interest": "0.1",
"interestRate": "0.00001",
"interestAccuredTime": 1650465162165
}
]