User

Endpoints to fetch user records

get

Retrieve deposit records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/deposits

HTTPcURLJavaScriptPython

GET /user/{accountId}/deposits HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "amount": "text",
      "oraclePrice": "text",
      "marketDepositBalance": "text",
      "marketWithdrawBalance": "text",
      "marketCumulativeDepositInterest": "text",
      "marketCumulativeBorrowInterest": "text",
      "totalDepositsAfter": "text",
      "totalWithdrawsAfter": "text",
      "depositRecordId": "text",
      "userAuthority": "text",
      "user": "text",
      "direction": "text",
      "explanation": "text",
      "marketIndex": 1,
      "symbol": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve deposit records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/deposits/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/deposits/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "amount": "text",
      "oraclePrice": "text",
      "marketDepositBalance": "text",
      "marketWithdrawBalance": "text",
      "marketCumulativeDepositInterest": "text",
      "marketCumulativeBorrowInterest": "text",
      "totalDepositsAfter": "text",
      "totalWithdrawsAfter": "text",
      "depositRecordId": "text",
      "userAuthority": "text",
      "user": "text",
      "direction": "text",
      "explanation": "text",
      "marketIndex": 1,
      "symbol": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve reward records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/rewards

HTTPcURLJavaScriptPython

GET /user/{accountId}/rewards HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "amount": "text",
      "oraclePrice": "text",
      "marketDepositBalance": "text",
      "marketWithdrawBalance": "text",
      "marketCumulativeDepositInterest": "text",
      "marketCumulativeBorrowInterest": "text",
      "totalDepositsAfter": "text",
      "totalWithdrawsAfter": "text",
      "depositRecordId": "text",
      "userAuthority": "text",
      "user": "text",
      "direction": "text",
      "explanation": "text",
      "marketIndex": 1,
      "symbol": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve reward records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/rewards/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/rewards/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "amount": "text",
      "oraclePrice": "text",
      "marketDepositBalance": "text",
      "marketWithdrawBalance": "text",
      "marketCumulativeDepositInterest": "text",
      "marketCumulativeBorrowInterest": "text",
      "totalDepositsAfter": "text",
      "totalWithdrawsAfter": "text",
      "depositRecordId": "text",
      "userAuthority": "text",
      "user": "text",
      "direction": "text",
      "explanation": "text",
      "marketIndex": 1,
      "symbol": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve funding payment records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/fundingPayments

HTTPcURLJavaScriptPython

GET /user/{accountId}/fundingPayments HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "userAuthority": "text",
      "user": "text",
      "marketIndex": 1,
      "fundingPayment": "text",
      "baseAssetAmount": "text",
      "userLastCumulativeFunding": "text",
      "ammCumulativeFundingLong": "text",
      "ammCumulativeFundingShort": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve funding payment records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/fundingPayments/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/fundingPayments/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "userAuthority": "text",
      "user": "text",
      "marketIndex": 1,
      "fundingPayment": "text",
      "baseAssetAmount": "text",
      "userLastCumulativeFunding": "text",
      "ammCumulativeFundingLong": "text",
      "ammCumulativeFundingShort": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve liquidation records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 unique liquidations per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/liquidations

HTTPcURLJavaScriptPython

GET /user/{accountId}/liquidations HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "liquidationType": "text",
      "user": "text",
      "liquidator": "text",
      "marginRequirement": "text",
      "totalCollateral": "text",
      "marginFreed": "text",
      "liquidationId": "text",
      "bankrupt": true,
      "canceledOrderIds": [
        "text"
      ],
      "liquidatePerp_marketIndex": 1,
      "liquidatePerp_oraclePrice": "text",
      "liquidatePerp_baseAssetAmount": "text",
      "liquidatePerp_quoteAssetAmount": "text",
      "liquidatePerp_lpShares": "text",
      "liquidatePerp_fillRecordId": "text",
      "liquidatePerp_userOrderId": "text",
      "liquidatePerp_liquidatorOrderId": "text",
      "liquidatePerp_liquidatorFee": "text",
      "liquidatePerp_ifFee": "text",
      "liquidateSpot_assetMarketIndex": 1,
      "liquidateSpot_assetPrice": "text",
      "liquidateSpot_assetTransfer": "text",
      "liquidateSpot_liabilityMarketIndex": 1,
      "liquidateSpot_liabilityPrice": "text",
      "liquidateSpot_liabilityTransfer": "text",
      "liquidateSpot_ifFee": "text",
      "liquidateBorrowForPerpPnl_perpMarketIndex": 1,
      "liquidateBorrowForPerpPnl_marketOraclePrice": "text",
      "liquidateBorrowForPerpPnl_pnlTransfer": "text",
      "liquidateBorrowForPerpPnl_liabilityMarketIndex": 1,
      "liquidateBorrowForPerpPnl_liabilityPrice": "text",
      "liquidateBorrowForPerpPnl_liabilityTransfer": "text",
      "liquidatePerpPnlForDeposit_perpMarketIndex": 1,
      "liquidatePerpPnlForDeposit_marketOraclePrice": "text",
      "liquidatePerpPnlForDeposit_pnlTransfer": "text",
      "liquidatePerpPnlForDeposit_assetMarketIndex": 1,
      "liquidatePerpPnlForDeposit_assetPrice": "text",
      "liquidatePerpPnlForDeposit_assetTransfer": "text",
      "perpBankruptcy_marketIndex": 1,
      "perpBankruptcy_pnl": "text",
      "perpBankruptcy_ifPayment": "text",
      "perpBankruptcy_clawbackUser": "text",
      "perpBankruptcy_clawbackUserPayment": "text",
      "perpBankruptcy_cumulativeFundingRateDelta": "text",
      "spotBankruptcy_marketIndex": 1,
      "spotBankruptcy_borrowAmount": "text",
      "spotBankruptcy_ifPayment": "text",
      "spotBankruptcy_cumulativeDepositInterestDelta": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve liquidation records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/liquidations/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/liquidations/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "liquidationType": "text",
      "user": "text",
      "liquidator": "text",
      "marginRequirement": "text",
      "totalCollateral": "text",
      "marginFreed": "text",
      "liquidationId": "text",
      "bankrupt": true,
      "canceledOrderIds": [
        "text"
      ],
      "liquidatePerp_marketIndex": 1,
      "liquidatePerp_oraclePrice": "text",
      "liquidatePerp_baseAssetAmount": "text",
      "liquidatePerp_quoteAssetAmount": "text",
      "liquidatePerp_lpShares": "text",
      "liquidatePerp_fillRecordId": "text",
      "liquidatePerp_userOrderId": "text",
      "liquidatePerp_liquidatorOrderId": "text",
      "liquidatePerp_liquidatorFee": "text",
      "liquidatePerp_ifFee": "text",
      "liquidateSpot_assetMarketIndex": 1,
      "liquidateSpot_assetPrice": "text",
      "liquidateSpot_assetTransfer": "text",
      "liquidateSpot_liabilityMarketIndex": 1,
      "liquidateSpot_liabilityPrice": "text",
      "liquidateSpot_liabilityTransfer": "text",
      "liquidateSpot_ifFee": "text",
      "liquidateBorrowForPerpPnl_perpMarketIndex": 1,
      "liquidateBorrowForPerpPnl_marketOraclePrice": "text",
      "liquidateBorrowForPerpPnl_pnlTransfer": "text",
      "liquidateBorrowForPerpPnl_liabilityMarketIndex": 1,
      "liquidateBorrowForPerpPnl_liabilityPrice": "text",
      "liquidateBorrowForPerpPnl_liabilityTransfer": "text",
      "liquidatePerpPnlForDeposit_perpMarketIndex": 1,
      "liquidatePerpPnlForDeposit_marketOraclePrice": "text",
      "liquidatePerpPnlForDeposit_pnlTransfer": "text",
      "liquidatePerpPnlForDeposit_assetMarketIndex": 1,
      "liquidatePerpPnlForDeposit_assetPrice": "text",
      "liquidatePerpPnlForDeposit_assetTransfer": "text",
      "perpBankruptcy_marketIndex": 1,
      "perpBankruptcy_pnl": "text",
      "perpBankruptcy_ifPayment": "text",
      "perpBankruptcy_clawbackUser": "text",
      "perpBankruptcy_clawbackUserPayment": "text",
      "perpBankruptcy_cumulativeFundingRateDelta": "text",
      "spotBankruptcy_marketIndex": 1,
      "spotBankruptcy_borrowAmount": "text",
      "spotBankruptcy_ifPayment": "text",
      "spotBankruptcy_cumulativeDepositInterestDelta": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve LP records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/lp

HTTPcURLJavaScriptPython

GET /user/{accountId}/lp HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "user": "text",
      "action": "text",
      "marketIndex": 1,
      "nShares": "text",
      "deltaBaseAssetAmount": "text",
      "deltaQuoteAssetAmount": "text",
      "pnl": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve LP records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/lp/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/lp/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "user": "text",
      "action": "text",
      "marketIndex": 1,
      "nShares": "text",
      "deltaBaseAssetAmount": "text",
      "deltaQuoteAssetAmount": "text",
      "pnl": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve orders for a specific account and market type, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

marketFilterstring · enumRequiredPossible values:

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/orders/{marketFilter}

HTTPcURLJavaScriptPython

GET /user/{accountId}/orders/{marketFilter} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "user": "text",
      "status": "text",
      "orderType": "text",
      "marketType": "text",
      "marketFilter": "text",
      "orderId": 1,
      "userOrderId": 1,
      "marketIndex": 1,
      "price": "text",
      "baseAssetAmount": "text",
      "quoteAssetAmount": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "direction": "text",
      "reduceOnly": true,
      "triggerPrice": "text",
      "triggerCondition": "text",
      "existingPositionDirection": "text",
      "postOnly": true,
      "immediateOrCancel": true,
      "oraclePriceOffset": "text",
      "auctionDuration": 1,
      "auctionStartPrice": "text",
      "auctionEndPrice": "text",
      "maxTs": 1,
      "symbol": "text",
      "lastActionStatus": "partial_fill_cancelled",
      "lastActionExplanation": "text",
      "lastUpdatedTs": 1,
      "cumulativeFee": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve order for user by orderId.

Note: This endpoint provides orders within the last 31 days.

Path parameters

accountIdstringRequired

orderIdnumberRequired

Responses

200

Default Response

application/json

get

/user/{accountId}/orders/id/{orderId}

HTTPcURLJavaScriptPython

GET /user/{accountId}/orders/id/{orderId} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "record": {
    "ts": 1,
    "txSig": "text",
    "txSigIndex": 1,
    "slot": 1,
    "user": "text",
    "status": "text",
    "orderType": "text",
    "marketType": "text",
    "marketFilter": "text",
    "orderId": 1,
    "userOrderId": 1,
    "marketIndex": 1,
    "price": "text",
    "baseAssetAmount": "text",
    "quoteAssetAmount": "text",
    "baseAssetAmountFilled": "text",
    "quoteAssetAmountFilled": "text",
    "direction": "text",
    "reduceOnly": true,
    "triggerPrice": "text",
    "triggerCondition": "text",
    "existingPositionDirection": "text",
    "postOnly": true,
    "immediateOrCancel": true,
    "oraclePriceOffset": "text",
    "auctionDuration": 1,
    "auctionStartPrice": "text",
    "auctionEndPrice": "text",
    "maxTs": 1,
    "symbol": "text",
    "lastActionStatus": "partial_fill_cancelled",
    "lastActionExplanation": "text",
    "lastUpdatedTs": 1,
    "cumulativeFee": "text"
  }
}

get

Retrieve order records for a specific account and market, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

marketFilterstring · enumRequiredPossible values:

symbolstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/orders/{marketFilter}/{symbol}

HTTPcURLJavaScriptPython

GET /user/{accountId}/orders/{marketFilter}/{symbol} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "user": "text",
      "status": "text",
      "orderType": "text",
      "marketType": "text",
      "marketFilter": "text",
      "orderId": 1,
      "userOrderId": 1,
      "marketIndex": 1,
      "price": "text",
      "baseAssetAmount": "text",
      "quoteAssetAmount": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "direction": "text",
      "reduceOnly": true,
      "triggerPrice": "text",
      "triggerCondition": "text",
      "existingPositionDirection": "text",
      "postOnly": true,
      "immediateOrCancel": true,
      "oraclePriceOffset": "text",
      "auctionDuration": 1,
      "auctionStartPrice": "text",
      "auctionEndPrice": "text",
      "maxTs": 1,
      "symbol": "text",
      "lastActionStatus": "partial_fill_cancelled",
      "lastActionExplanation": "text",
      "lastUpdatedTs": 1,
      "cumulativeFee": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve the update actions to an order. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

orderIdnumberRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/orders/{orderId}/actions

HTTPcURLJavaScriptPython

GET /user/{accountId}/orders/{orderId}/actions HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve prediction records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/predictions

HTTPcURLJavaScriptPython

GET /user/{accountId}/predictions HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve prediction records for a specific account and BET market, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

symbolstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/predictions/{symbol}

HTTPcURLJavaScriptPython

GET /user/{accountId}/predictions/{symbol} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve prediction records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/predictions/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/predictions/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve settle pnl records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/settlePnl

HTTPcURLJavaScriptPython

GET /user/{accountId}/settlePnl HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "pnl": "text",
      "user": "text",
      "baseAssetAmount": "text",
      "quoteAssetAmountAfter": "text",
      "quoteEntryAmount": "text",
      "settlePrice": "text",
      "marketIndex": 1,
      "explanation": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve settle pnl records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/settlePnl/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/settlePnl/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "pnl": "text",
      "user": "text",
      "baseAssetAmount": "text",
      "quoteAssetAmountAfter": "text",
      "quoteEntryAmount": "text",
      "settlePrice": "text",
      "marketIndex": 1,
      "explanation": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve swap records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/swaps

HTTPcURLJavaScriptPython

GET /user/{accountId}/swaps HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "user": "text",
      "outMarketIndex": 1,
      "inMarketIndex": 1,
      "outSymbol": "text",
      "inSymbol": "text",
      "isInMarket": true,
      "amountOut": "text",
      "amountIn": "text",
      "outOraclePrice": "text",
      "inOraclePrice": "text",
      "fee": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve trade records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/swaps/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/swaps/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "user": "text",
      "outMarketIndex": 1,
      "inMarketIndex": 1,
      "outSymbol": "text",
      "inSymbol": "text",
      "isInMarket": true,
      "amountOut": "text",
      "amountIn": "text",
      "outOraclePrice": "text",
      "inOraclePrice": "text",
      "fee": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve trade records for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/trades

HTTPcURLJavaScriptPython

GET /user/{accountId}/trades HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve trade records for a specific account and market, with optional pagination. Results are ordered from newest to oldest, with up to 20 records per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

symbolstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/trades/{symbol}

HTTPcURLJavaScriptPython

GET /user/{accountId}/trades/{symbol} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}

get

Retrieve trade records for a specific account for a given year and month.

Path parameters

accountIdstringRequired

yearinteger · min: 2022Required

Year in YYYY format

monthinteger · min: 1 · max: 12Required

Month from 1 to 12

Query parameters

pagenumberOptional

formatstring · enumOptionalDefault: jsonPossible values:

Responses

200

Default Response

application/json

get

/user/{accountId}/trades/{year}/{month}

HTTPcURLJavaScriptPython

GET /user/{accountId}/trades/{year}/{month} HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "records": 1,
    "totalRecords": 1,
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": 1,
    "includesLatest": true
  }
}

get

Retrieve position closing trade records accumulated by orderId for a specific account, with optional pagination. Results are ordered from newest to oldest, with up to 20 unique orders per request.

Note: This endpoint provides records for the last 31 days.

Path parameters

accountIdstringRequired

Query parameters

pagestringOptional

Responses

200

Default Response

application/json

get

/user/{accountId}/positions

HTTPcURLJavaScriptPython

GET /user/{accountId}/positions HTTP/1.1
Host: 
Accept: */*

200

Default Response

{
  "success": true,
  "records": [
    {
      "ts": 1,
      "txSig": "text",
      "txSigIndex": 1,
      "slot": 1,
      "fillerReward": "text",
      "baseClosedForPnl": "text",
      "baseAssetAmountFilled": "text",
      "quoteAssetAmountFilled": "text",
      "takerFee": "text",
      "makerRebate": "text",
      "referrerReward": "text",
      "quoteAssetAmountSurplus": "text",
      "takerOrderBaseAssetAmount": "text",
      "takerOrderCumulativeBaseAssetAmountFilled": "text",
      "takerOrderCumulativeQuoteAssetAmountFilled": "text",
      "makerOrderBaseAssetAmount": "text",
      "makerOrderCumulativeBaseAssetAmountFilled": "text",
      "makerOrderCumulativeQuoteAssetAmountFilled": "text",
      "oraclePrice": "text",
      "makerFee": "text",
      "action": "text",
      "actionExplanation": "text",
      "marketIndex": 1,
      "marketType": "text",
      "marketFilter": "text",
      "filler": "text",
      "fillRecordId": "text",
      "taker": "text",
      "takerOrderId": "text",
      "takerOrderDirection": "text",
      "maker": "text",
      "makerOrderId": "text",
      "makerOrderDirection": "text",
      "spotFulfillmentMethodFee": "text",
      "userFee": "text",
      "user": "text",
      "symbol": "text",
      "bitFlags": 1,
      "userExistingQuoteEntryAmount": "text",
      "userExistingBaseAssetAmount": "text",
      "takerExistingQuoteEntryAmount": "text",
      "takerExistingBaseAssetAmount": "text",
      "makerExistingQuoteEntryAmount": "text",
      "makerExistingBaseAssetAmount": "text"
    }
  ],
  "meta": {
    "nextPage": "text"
  }
}