xrpl
    Preparing search index...

    Interface NFTBuyOffersRequest

    The nft_buy_offers method retrieves all of buy offers for the specified NFToken.

    interface NFTBuyOffersRequest {
        api_version?: number;
        command: "nft_buy_offers";
        id?: string | number;
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        marker?: unknown;
        nft_id: string;
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [x: string]: unknown
    Index

    Properties

    api_version? command id? ledger_hash? ledger_index? limit? marker? nft_id

    Properties

    api_version?: number

    The API version to use. If omitted, use version 1.

    command: "nft_buy_offers"

    The name of the API method.

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string.

    limit?: number

    Limit the number of NFT buy offers to retrieve. The server may return fewer results. Valid values are within 50-500. The default is 250.

    marker?: unknown

    Value from a previous paginated response. Resume retrieving data where that response left off.

    nft_id: string

    The unique identifier of an NFToken. The request returns buy offers for this NFToken.

    Settings

    Member Visibility

    On This Page

    Properties