Interface OrdersApiListOrdersV3Request

interface OrdersApiListOrdersV3Request {
    pageSize?: number;
    cursor?: string;
    orderBy?:
        | "updated_at"
        | "created_at"
        | "expired_at"
        | "sell_quantity"
        | "buy_quantity"
        | "buy_quantity_with_fees";
    direction?: string;
    user?: string;
    status?:
        | "active"
        | "filled"
        | "cancelled"
        | "expired"
        | "inactive";
    minTimestamp?: string;
    maxTimestamp?: string;
    updatedMinTimestamp?: string;
    updatedMaxTimestamp?: string;
    buyTokenType?: string;
    buyTokenId?: string;
    buyAssetId?: string;
    buyTokenAddress?: string;
    buyTokenName?: string;
    buyMinQuantity?: string;
    buyMaxQuantity?: string;
    buyMetadata?: string;
    sellTokenType?: string;
    sellTokenId?: string;
    sellAssetId?: string;
    sellTokenAddress?: string;
    sellTokenName?: string;
    sellMinQuantity?: string;
    sellMaxQuantity?: string;
    sellMetadata?: string;
    auxiliaryFeePercentages?: string;
    auxiliaryFeeRecipients?: string;
    includeFees?: boolean;
}

Hierarchy

  • OrdersApiListOrdersV3Request
    • OrdersApiListOrdersV3Request

Properties

pageSize? cursor? orderBy? direction? user? status? minTimestamp? maxTimestamp? updatedMinTimestamp? updatedMaxTimestamp? buyTokenType? buyTokenId? buyAssetId? buyTokenAddress? buyTokenName? buyMinQuantity? buyMaxQuantity? buyMetadata? sellTokenType? sellTokenId? sellAssetId? sellTokenAddress? sellTokenName? sellMinQuantity? sellMaxQuantity? sellMetadata? auxiliaryFeePercentages? auxiliaryFeeRecipients? includeFees?

Properties

Optional ReadonlypageSize

pageSize?: number

Page size of the result

Memberof

OrdersApiListOrdersV3

Optional Readonlycursor

cursor?: string

Cursor

Memberof

OrdersApiListOrdersV3

Optional ReadonlyorderBy

orderBy?:
    | "updated_at"
    | "created_at"
    | "expired_at"
    | "sell_quantity"
    | "buy_quantity"
    | "buy_quantity_with_fees"

Property to sort by

Memberof

OrdersApiListOrdersV3

Optional Readonlydirection

direction?: string

Direction to sort (asc/desc)

Memberof

OrdersApiListOrdersV3

Optional Readonlyuser

user?: string

Ethereum address of the user who submitted this order

Memberof

OrdersApiListOrdersV3

Optional Readonlystatus

status?:
    | "active"
    | "filled"
    | "cancelled"
    | "expired"
    | "inactive"

Status of this order

Memberof

OrdersApiListOrdersV3

Optional ReadonlyminTimestamp

minTimestamp?: string

Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

OrdersApiListOrdersV3

Optional ReadonlymaxTimestamp

maxTimestamp?: string

Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

OrdersApiListOrdersV3

Optional ReadonlyupdatedMinTimestamp

updatedMinTimestamp?: string

Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

OrdersApiListOrdersV3

Optional ReadonlyupdatedMaxTimestamp

updatedMaxTimestamp?: string

Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyTokenType

buyTokenType?: string

Token type of the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyTokenId

buyTokenId?: string

ERC721 Token ID of the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyAssetId

buyAssetId?: string

Internal IMX ID of the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyTokenAddress

buyTokenAddress?: string

Token address of the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyTokenName

buyTokenName?: string

Token name of the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyMinQuantity

buyMinQuantity?: string

Min quantity for the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyMaxQuantity

buyMaxQuantity?: string

Max quantity for the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlybuyMetadata

buyMetadata?: string

JSON-encoded metadata filters for the asset this order buys

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellTokenType

sellTokenType?: string

Token type of the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellTokenId

sellTokenId?: string

ERC721 Token ID of the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellAssetId

sellAssetId?: string

Internal IMX ID of the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellTokenAddress

sellTokenAddress?: string

Token address of the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellTokenName

sellTokenName?: string

Token name of the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellMinQuantity

sellMinQuantity?: string

Min quantity for the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellMaxQuantity

sellMaxQuantity?: string

Max quantity for the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlysellMetadata

sellMetadata?: string

JSON-encoded metadata filters for the asset this order sells

Memberof

OrdersApiListOrdersV3

Optional ReadonlyauxiliaryFeePercentages

auxiliaryFeePercentages?: string

Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients

Memberof

OrdersApiListOrdersV3

Optional ReadonlyauxiliaryFeeRecipients

auxiliaryFeeRecipients?: string

Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages

Memberof

OrdersApiListOrdersV3

Optional ReadonlyincludeFees

includeFees?: boolean

Set flag to true to include fee object for orders

Memberof

OrdersApiListOrdersV3

Settings

Member Visibility

On This Page

Properties