Skip to main content

Accounts

Account Information

  • GET https://api.poloniex.com/accounts

Get a list of all accounts of a user.

Response FieldData TypeDescription
accountIdStringaccount ID
accountTypeStringaccount type. Currently only SPOT is supported
accountStateStringaccount'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 ParameterData TypeRequiredDescription
accountTypeStringfalseThe account type. e.g. SPOT. Default will show all account types if not specified. Currently only SPOT is supported
Response FieldData TypeDescription
accountIdStringaccount ID
accountTypeStringaccount type. Currently, SPOT is the only supported one.
balancesJsonaccount's assets
Balances FieldData TypeDescription
currencyIdStringcurrency id
currencyStringcurrency name
availableStringavailable amount for the currency. can be negative due to margin
holdStringfrozen 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 ParameterData TypeRequiredDescription
idLongtrueaccount 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 ParameterData TypeRequiredDescription
startTimeLongfalse(milliseconds since UNIX epoch) trades filled before startTime will not be retrieved.
endTimeLongfalse(milliseconds since UNIX epoch) trades filled after endTime will not be retrieved.
activityTypeIntegerfalseType of activity: ALL: 200, AIRDROP: 201, COMMISSION_REBATE: 202, STAKING: 203, REFERAL_REBATE: 204, CREDIT_ADJUSTMENT: 104, DEBIT_ADJUSTMENT: 105, OTHER: 199
limitIntegerfalseThe max number of records could be returned. Default is 100 and max is 1000.
fromLongfalseIt is 'id'. The query begin at ‘from', and the default is 0.
directionStringfalsePRE, NEXT, default is NEXT
currencyStringfalseThe transferred currency, like USDT. Default is for all currencies, if not specified.
Response FieldData TypeDescription
idStringactivity id
currencyStringcurrency like BTC, ETH etc
amountStringamount of the activity (can be negative)
stateStringstate of the activity e.g. SUCCESS, PROCESSSING, FAILED
createTimeLongdatetime of the activity
descriptionStringactivity details
activityTypeIntegertype 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 ParameterData TypeRequiredDescription
currencyStringtrueThe currency to transfer, like USDT
amountStringtrueThe amount to transfer.
fromAccountStringtrueThe account, from which the currency is transferred.
toAccountStringtrueThe account, to which the currency is transferred.
Example request:
{
"currency": "USDT",
"amount": "10.5",
"fromAccount": "SPOT",
"toAccount": "FUTURES"
}
Response FieldData TypeDescription
transferIdStringtransfer 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 ParameterData TypeRequiredDescription
limitIntegerfalseThe max number of records could be returned. Default is 100 and max is 1000 records.
fromLongfalseit is 'transferId'. The query begin at ‘from', and the default is 0.
directionStringfalsePRE, NEXT, default is NEXT
currencyStringfalseThe transferred currency, like USDT. Default is for all currencies, if not specified.
startTimeLongfalse(milliseconds since UNIX epoch) transfers before start time will not be retrieved.
endTimeLongfalse(milliseconds since UNIX epoch) transfers after end time will not be retrieved.
Response FieldData TypeDescription
idStringtransfer ID
fromAccountStringthe account, from which the currency is transferred.
toAccountStringthe account, to which the currency is transferred.
currencyStringthe transferred currency
amountStringthe transferred amount
stateStringthe state of transfer operation. e.g. SUCCESS, PROCESSSING, FAILED
createTimeLongthe 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 ParameterData TypeRequiredDescription
idLongtruetransfer 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 FieldData TypeDescription
trxDiscountBooleanDiscount exists if using TRX
makerRateStringMaker rate
takerRateStringTaker rate
volume30DString30 days volume in USDT
specialFeeRatesJson ArrayCustom fee rates for symbols
specialFeeRates
Response FieldData TypeDescription
symbolStringsymbol name
makerRateStringMaker rate
takerRateStringTaker 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 ParameterData TypeRequiredDescription
limitIntegerfalseThe max number of records could be returned. Default is 10 and max is 100 records.
fromLongfalseit is 'id'. The query begin at ‘from', and the default is 0.
directionStringfalsePRE, NEXT, default is NEXT
startTimeLongfalse(milliseconds since UNIX epoch) records before start time will not be retrieved.
endTimeLongfalse(milliseconds since UNIX epoch) records after end time will not be retrieved.
Response FieldData TypeDescription
idStringrecord ID
interestAccuredTimeLongInterest collection time.
currencyNameStringAsset name.
principalStringPrincipal.
interestStringinterest.
interestRateStringinterest 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
}
]