Interface ListDeFiInvestmentsRequest

Request parameters for listDeFiInvestments operation in DefiDataApi. ListDeFiInvestmentsRequest

interface ListDeFiInvestmentsRequest {
    binanceChainId?: string;
    defiProtocolId?: string;
    investType: ListDeFiInvestmentsInvestTypeEnum;
    nonce?: string;
    page?: number;
    recvWindow?: number | bigint;
    size?: number;
    sortDirection?: ListDeFiInvestmentsSortDirectionEnum;
    sortField?: string;
    tokenAddressList?: string[];
}

Index

Properties

binanceChainId? defiProtocolId? investType nonce? page? recvWindow? size? sortDirection? sortField? tokenAddressList?

Properties

`Optional` `Readonly`binanceChainId

binanceChainId?: string

One of the supported chains — see Supported Chains & Protocols for the supported chain ID values. Chains outside this whitelist are rejected with 40001. When omitted (or blank), results span all supported chains.

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`defiProtocolId

defiProtocolId?: string

Filter by DeFi protocol ID.

Memberof

DefiDataApiListDeFiInvestments

`Readonly`investType

investType: ListDeFiInvestmentsInvestTypeEnum

Filter by investment type. Required. Known values: Earn, LiquidityPool.

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`nonce

nonce?: string

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

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`page

page?: number

Page number (1-based).

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`recvWindow

recvWindow?: number | bigint

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

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`size

size?: number

Page size. Max: 100.

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`sortDirection

sortDirection?: ListDeFiInvestmentsSortDirectionEnum

Sort direction.

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`sortField

sortField?: string

Field to sort by. Only two values are accepted: tvl, apy. Note: sorting by APY uses apy (the server-side field name), even though the response exposes apyBps / apyDisplay. Other values are not supported.

Memberof

DefiDataApiListDeFiInvestments

`Optional` `Readonly`tokenAddressList

tokenAddressList?: string[]

Filter by token addresses. When this field is provided, binanceChainId is required — the same address can be a different token on different chains; omitting the chain returns 40001.

Memberof

DefiDataApiListDeFiInvestments