Interface GetLeaderboardRequest

Request parameters for getLeaderboard operation in AddressPortfolioApi. GetLeaderboardRequest

interface GetLeaderboardRequest {
    binanceChainId: string;
    cursor?: string;
    limit?: string;
    maxRealizedPnlUsd?: string;
    maxTxs?: string;
    maxTxVolume?: string;
    maxWinRatePercent?: string;
    minRealizedPnlUsd?: string;
    minTxs?: string;
    minTxVolume?: string;
    minWinRatePercent?: string;
    nonce?: string;
    recvWindow?: number | bigint;
    sortBy: GetLeaderboardSortByEnum;
    timeFrame: GetLeaderboardTimeFrameEnum;
    walletType?: GetLeaderboardWalletTypeEnum;
}

Index

Properties

binanceChainId cursor? limit? maxRealizedPnlUsd? maxTxs? maxTxVolume? maxWinRatePercent? minRealizedPnlUsd? minTxs? minTxVolume? minWinRatePercent? nonce? recvWindow? sortBy timeFrame walletType?

Properties

`Readonly`binanceChainId

binanceChainId: string

Unique chain identifier (e.g. "1"=Ethereum, "56"=BSC, "CT_501"=Solana). Single chain only.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`cursor

cursor?: string

Pagination cursor. Omit or pass empty string for the first page.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`limit

limit?: string

Number of records per page. Default 50, max 50.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`maxRealizedPnlUsd

maxRealizedPnlUsd?: string

Maximum realized PnL filter, denominated in USD.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`maxTxs

maxTxs?: string

Maximum transaction count filter.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`maxTxVolume

maxTxVolume?: string

Maximum total transaction volume filter, denominated in USD.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`maxWinRatePercent

maxWinRatePercent?: string

Maximum win rate filter, without percent sign. "90" means ≤90%.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`minRealizedPnlUsd

minRealizedPnlUsd?: string

Minimum realized PnL filter, denominated in USD.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`minTxs

minTxs?: string

Minimum transaction count filter.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`minTxVolume

minTxVolume?: string

Minimum total transaction volume filter, denominated in USD.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`minWinRatePercent

minWinRatePercent?: string

Minimum win rate filter, without percent sign. "50" means ≥50%.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`nonce

nonce?: string

Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`recvWindow

recvWindow?: number | bigint

Allowed time deviation in milliseconds (default: 5000, max: 60000).

Memberof

AddressPortfolioApiGetLeaderboard

`Readonly`sortBy

sortBy: GetLeaderboardSortByEnum

Sort field. 1=Realized PnL (USD), 2=Win Rate, 3=Transaction count, 4=Volume (USD), 5=Realized PnL %.

Memberof

AddressPortfolioApiGetLeaderboard

`Readonly`timeFrame

timeFrame: GetLeaderboardTimeFrameEnum

Statistics time range. 1=7D, 2=1M, 3=3M. Note: these values differ from the portfolio/overview endpoint (where 1=1D, 2=7D, 3=1M, 4=3M); do not reuse enum knowledge across endpoints.

Memberof

AddressPortfolioApiGetLeaderboard

`Optional` `Readonly`walletType

walletType?: GetLeaderboardWalletTypeEnum

Wallet type filter, single selection only. 1=Smart Money, 2=KOL, 3=Hot List. Returns all types when omitted.

Memberof

AddressPortfolioApiGetLeaderboard