Rubin Documentation

Get Funding Payments

Retrieves funding payment history for a specific subaccount. Funding payments are periodic settlements that occur between long and short positions based on the funding rate.

Method Declaration

Python

async def get_funding_payments(
    self,
    address: str,
    subaccount_number: int,
    limit: Optional[int] = None,
    ticker: Optional[str] = None,
    after_or_at: Optional[str] = None,
    page: Optional[int] = None,
) -> Any

Unification Plan

Rename all methods to get_funding_payments - shorter is better.
Add a Subaccount pair to Python and JavaScript, since it's always a pair
page optional parameter is missing in Python
page optional parameter is missing in Rust

Parameters

Parameter	Location	Type	Required	Description
`address`	query	Address	true	The wallet address that owns the account.
`subaccountNumber`	query	SubaccountNumber	true	The identifier for the specific subaccount within the wallet address.
`limit`	query	u32	false	Maximum number of funding payments to return in the response.
`ticker`	query	Ticker	false	The market symbol to filter funding payments by (e.g., "BTC-USD"). If not provided, payments for all markets will be returned.
`afterOrAt`	query	DateTime	false	Filters results to funding payments created at or after a specific timestamp (ISO 8601 format).
`page`	query	u32	false	The page number for paginated results.

Response

A promise that resolves to funding payment data containing details such as payment amount, funding rate, position size, market ticker, and timestamp information.

Status	Meaning	Schema	Description
`200`	OK	FundingPaymentsResponseObject ⛁	The funding payments data.

API Example