Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orderly.network/docs/llms.txt

Use this file to discover all available pages before exploring further.

Funding-fee payment history for an address. Each row shows the funding rate at the epoch, the resulting fee, and whether the fee has been settled. Weight: 5

Request

{
  "type": "fundingPayments",
  "address": "0x1234567890abcdef1234567890abcdef12345678",
  "symbol": "PERP_BTC_USDC",
  "start_time": 1715000000000,
  "limit": 100
}
FieldTypeRequiredDefaultNotes
addressstringYesWallet address
broker_idstringNoOptional broker scope
account_idstringNoOptional
symbolstringNoSymbol filter
start_timeint64Noms epoch
end_timeint64Noms epoch
limitintNo1001..500
cursorstringNoOpaque cursor

Response

FieldTypeNotes
funding_ratestringPer-8h cycle decimal
funding_feestringSigned: > 0 → user pays, < 0 → user receives
position_qty, mark_pricestringSnapshot at the funding epoch
funding_rate_timestampint64Funding epoch (ms epoch UTC)
payment_typestring | null"Pay" / "Receive" / null when funding_fee == 0
funding_statusstring"Settled" (≤ latest settled version) or "Accrued" (pending; often funding_fee == 0). Defaults to "Settled" if the settlement table is unavailable
margin_modestring"CROSS" or "ISOLATED"

Notes

  • Default behavior: no time filter — returns the entire history. Use start_time to bound the window.
{
  "success": true,
  "data": {
    "rows": [
      {
        "symbol": "PERP_BTC_USDC",
        "funding_rate": "0.0001",
        "funding_fee": "10.50",
        "position_qty": "0.5",
        "mark_price": "45000.00",
        "funding_rate_timestamp": 1714900000000,
        "payment_type": "Pay",
        "funding_status": "Settled",
        "margin_mode": "CROSS"
      }
    ],
    "next_cursor": null
  },
  "ts": 1779269143700
}