CheckpointService
List My Checkpoints
List every checkpoint of the authenticated caller's root account, newest first. Checkpoints are private to the account owner.
Request
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/checkpoints?subaccountId=45LUmqjT' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"checkpoints": [
{
"amends": "1",
"badges": [
{
"badge": "FIRST_TRADE",
"earnedAt": "2025-01-01T00:00:00Z"
}
],
"biggestTrade": {
"at": "2025-01-01T00:00:00Z",
"side": "BUY",
"symbol": "BTC-USDT",
"symbolId": 1
},
"biggestTradeUsd": "value",
"busiestDay": "value",
"cancelRatio": "value",
"canceledOrders": "1",
"dailyClaimAmounts": [
{
"amount": "123.45",
"asset": "value",
"excludedFromValue": false,
"usd": "value"
}
],
"dailyClaims": "1",
"dailyVolume": [
{
"approximate": false,
"day": "2025-01-01T00:00:00Z",
"trades": "1",
"usd": "value"
}
],
"daysActive": 1,
"deposits": {
"amounts": [
{
"amount": "123.45",
"asset": "value",
"excludedFromValue": false,
"usd": "value"
}
],
"chains": [
{
"chainName": "value",
"polyesterChainId": 1,
"total": {
"count": "1",
"usd": "value"
}
}
],
"count": "1"
},
"fillRate": "value",
"filledOrders": "1",
"finalValueUsd": "value",
"firstTradeAt": "2025-01-01T00:00:00Z",
"fundingBalances": [
{
"amount": "123.45",
"asset": "value",
"excludedFromValue": false,
"usd": "value"
}
],
"fundingByDay": [
{
"date": "value",
"depositUsd": "value",
"withdrawalUsd": "value"
}
],
"incomplete": [
"VOLUME"
],
"inflowUsd": "value",
"internalTransfers": "1",
"longestStreak": 1,
"makerTrades": "1",
"marketsTraded": 1,
"medianLimitRestMs": "1",
"mostActiveHourUtc": 23,
"netInflowUsd": "value",
"number": 1,
"openingValueUsd": "value",
"orderTypes": {
"limit": "100",
"market": "1"
},
"orders": "1",
"outflowUsd": "value",
"partiallyFilledOrders": "1",
"peakVipTier": 10,
"portfolioValue": [
{
"approximate": false,
"hour": "2025-01-01T00:00:00Z",
"usd": "value"
}
],
"postOnly": "1",
"rejectedOrders": "1",
"seasonEnd": "2025-01-01T00:00:00Z",
"seasonResultUsd": "value",
"seasonStart": "2025-01-01T00:00:00Z",
"selfTrades": "1",
"subaccounts": "1",
"takenAt": "2025-01-01T00:00:00Z",
"takerTrades": "1",
"timeInForce": {
"fok": "1",
"gtc": "1",
"gtd": "1",
"ioc": "1"
},
"tools": {
"ladder": "1",
"stopLoss": "1",
"takeProfit": "1",
"trailingStop": "1",
"twap": "1"
},
"topPairs": [
{
"symbol": "BTC-USDT",
"symbolId": 1,
"trades": "1",
"volumeUsd": "12.3456"
}
],
"trades": "1",
"tradesByWeekdayHour": [
{
"hours": [
"1"
]
}
],
"tradingBalances": [
{
"amount": "123.45",
"asset": "value",
"excludedFromValue": false,
"usd": "value"
}
],
"transfersIn": {
"count": "1",
"usd": "value"
},
"transfersOut": {
"count": "1",
"usd": "value"
},
"vipTierAtCheckpoint": 10,
"vipTimeline": [
{
"date": "value",
"tier": 10
}
],
"volumeUsd": "12.3456",
"withdrawals": {
"amounts": [
{
"amount": "123.45",
"asset": "value",
"excludedFromValue": false,
"usd": "value"
}
],
"chains": [
{
"chainName": "value",
"polyesterChainId": 1,
"total": {
"count": "1",
"usd": "value"
}
}
],
"count": "1"
}
}
]
}Optional subaccount public identifier. Checkpoints cover a root account and all of its subaccounts, so a subaccount resolves to its root account, which must be the caller's own.
Positive checkpoint number. Checkpoint 1 is the first season; numbers increase by season.
1UTC start of the season, inclusive.
2025-01-01T00:00:00ZUTC end of the season, exclusive.
2025-01-01T00:00:00ZUTC time at which the checkpoint was recorded.
2025-01-01T00:00:00ZSeason trading volume in USD, encoded as a non-negative base-10 decimal string without separators or a currency symbol.
12.3456Number of trade fills.
1Number of orders placed.
1Number of UTC days with at least one trade.
1Longest run of consecutive UTC days with at least one trade.
1Stable numeric spot market identifier.
1Display symbol of the market, for example BTC-USDT. Empty when the market is no longer listed.
BTC-USDTSeason trading volume on this market in USD, encoded as a non-negative base-10 decimal string without separators or a currency symbol.
12.3456Number of trade fills on this market.
1Number of different markets traded.
1Trade fills on the maker side.
1Trade fills on the taker side.
1Trade fills where both sides belonged to this account.
1Exactly 24 counts, one per UTC hour of the day from 0 through 23.
["1"]UTC midnight that starts the day.
2025-01-01T00:00:00ZSettled trading volume of the day in USD, encoded as a non-negative base-10 decimal string without separators or a currency symbol.
valueTrue when the day's volume is a lower bound because some of its trades could not be valued.
falseNumber of trade fills on the day, including fills against the account's own orders, which add no volume.
1Largest single trade fill in USD, encoded as a non-negative base-10 decimal string without separators or a currency symbol.
valueStable numeric spot market identifier.
1Display symbol of the market, for example BTC-USDT. Empty when the market is no longer listed.
BTC-USDTThe account's side of the fill.
BUYUTC time of the fill.
2025-01-01T00:00:00ZLimit orders.
100Market orders.
1Good-till-canceled orders.
1Immediate-or-cancel orders.
1Fill-or-kill orders.
1Good-till-date orders.
1Stop-loss uses.
1Take-profit uses.
1Trailing-stop uses.
1TWAP uses.
1Ladder uses.
1Post-only orders placed.
1Orders amended at least once.
1Orders that ended fully filled.
1Orders that ended canceled or rejected after a partial fill.
1Orders that ended canceled.
1Orders that ended rejected.
1Share of placed orders that ended fully filled, a base-10 decimal string from 0 to 1.
valueShare of placed orders that ended canceled, a base-10 decimal string from 0 to 1.
valueTypical time a good-till-canceled or good-till-date limit order rested before it filled or was canceled, in milliseconds. Omitted when no such order ended in the season.
1UTC time of the first trade fill in the season. Omitted without trades.
2025-01-01T00:00:00ZUTC date with the most trade fills, formatted as YYYY-MM-DD. Omitted without trades.
valueUTC hour of day, 0 through 23, with the most trade fills. Omitted without trades.
23VIP tier at the moment the checkpoint was recorded, 0 through 10.
10Highest VIP tier reached during the season, 0 through 10.
10UTC date from which the tier applies, formatted as YYYY-MM-DD.
valueVIP tier in the inclusive range 0 through 10.
10The badge.
FIRST_TRADEUTC time the badge's threshold was first crossed, within the season.
2025-01-01T00:00:00ZUTC start of the hour.
2025-01-01T00:00:00ZPortfolio value in USD, encoded as a base-10 decimal string without separators or a currency symbol.
valueTrue when this value is approximate because some holdings could not be valued at that hour.
falseAsset symbol, for example USDT.
valueAmount in whole asset units, encoded as a base-10 decimal string without separators.
123.45USD value, encoded as a base-10 decimal string without separators or a currency symbol. Omitted when the asset had no USD price at the required time, and always when excluded_from_value is true.
valueTrue when the asset does not count toward account value, for example a test token that cannot be traded. It is listed by amount only, has no USD value and is left out of every USD total, which it never makes approximate or omitted.
falseAsset symbol, for example USDT.
valueAmount in whole asset units, encoded as a base-10 decimal string without separators.
123.45USD value, encoded as a base-10 decimal string without separators or a currency symbol. Omitted when the asset had no USD price at the required time, and always when excluded_from_value is true.
valueTrue when the asset does not count toward account value, for example a test token that cannot be traded. It is listed by amount only, has no USD value and is left out of every USD total, which it never makes approximate or omitted.
falseNumber of successful operations.
1Polyester Chain id.
1Display name of the chain, for example Ethereum Sepolia. Empty when the chain is not in the current chain catalog.
valueNumber of operations, including operations in assets excluded from value.
1USD total over assets that count toward account value, encoded as a non-negative base-10 decimal string without separators or a currency symbol. Assets excluded from value add nothing. Omitted when any other operation had no USD value.
valueAsset symbol, for example USDT.
valueAmount in whole asset units, encoded as a base-10 decimal string without separators.
123.45USD value, encoded as a base-10 decimal string without separators or a currency symbol. Omitted when the asset had no USD price at the required time, and always when excluded_from_value is true.
valueTrue when the asset does not count toward account value, for example a test token that cannot be traded. It is listed by amount only, has no USD value and is left out of every USD total, which it never makes approximate or omitted.
falseNumber of successful operations.
1Polyester Chain id.
1Display name of the chain, for example Ethereum Sepolia. Empty when the chain is not in the current chain catalog.
valueNumber of operations, including operations in assets excluded from value.
1USD total over assets that count toward account value, encoded as a non-negative base-10 decimal string without separators or a currency symbol. Assets excluded from value add nothing. Omitted when any other operation had no USD value.
valueAsset symbol, for example USDT.
valueAmount in whole asset units, encoded as a base-10 decimal string without separators.
123.45USD value, encoded as a base-10 decimal string without separators or a currency symbol. Omitted when the asset had no USD price at the required time, and always when excluded_from_value is true.
valueTrue when the asset does not count toward account value, for example a test token that cannot be traded. It is listed by amount only, has no USD value and is left out of every USD total, which it never makes approximate or omitted.
falseUTC date, formatted as YYYY-MM-DD.
valueUSD value of the day's deposits, encoded as a non-negative base-10 decimal string without separators or a currency symbol; "0" without a deposit. Omitted when a deposit had no USD value.
valueUSD value of the day's withdrawals, encoded as a non-negative base-10 decimal string without separators or a currency symbol; "0" without a withdrawal. Omitted when a withdrawal had no USD value.
valueNumber of operations, including operations in assets excluded from value.
1USD total over assets that count toward account value, encoded as a non-negative base-10 decimal string without separators or a currency symbol. Assets excluded from value add nothing. Omitted when any other operation had no USD value.
valueNumber of operations, including operations in assets excluded from value.
1USD total over assets that count toward account value, encoded as a non-negative base-10 decimal string without separators or a currency symbol. Assets excluded from value add nothing. Omitted when any other operation had no USD value.
valueInternal transfers made.
1Daily claims collected.
1Asset symbol, for example USDT.
valueAmount in whole asset units, encoded as a base-10 decimal string without separators.
123.45USD value, encoded as a base-10 decimal string without separators or a currency symbol. Omitted when the asset had no USD price at the required time, and always when excluded_from_value is true.
valueTrue when the asset does not count toward account value, for example a test token that cannot be traded. It is listed by amount only, has no USD value and is left out of every USD total, which it never makes approximate or omitted.
falseUSD value brought in during the season: daily claim payouts, deposits and transfers in, each valued when it happened, over assets that count toward account value; assets excluded from value add nothing. Encoded as a non-negative base-10 decimal string without separators or a currency symbol. Omitted when any other part had no USD value.
valueUSD value taken out during the season: withdrawals and transfers out, each valued when it happened, over assets that count toward account value; assets excluded from value add nothing. Encoded as a non-negative base-10 decimal string without separators or a currency symbol. Omitted when any other part had no USD value.
valueinflow_usd minus outflow_usd, encoded as a base-10 decimal string that may be negative. Omitted when either is omitted.
valueUSD value of all trading and funding balances at the end of the season that count toward account value, encoded as a base-10 decimal string. Assets excluded from value add nothing. Omitted when any other balance had no USD value.
valueUSD value of the funding balances restored to the account when the season opened, valued at the end of the season like final_value_usd, over assets that count toward account value; assets excluded from value add nothing. Encoded as a non-negative base-10 decimal string without separators or a currency symbol; "0" when the season opened with no balances. Omitted when a restored balance had no USD value.
valueSeason result: final_value_usd minus opening_value_usd minus net_inflow_usd, encoded as a base-10 decimal string that may be negative. Price moves on restored holdings are not counted as result. Omitted when any of them is omitted.
valueSubaccounts of the account.
1Values computed from partial evidence, in ascending enum order. Empty when every value is exact.
["VOLUME"]| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |