Interface AssetsApiListAssetsRequest

interface AssetsApiListAssetsRequest {
    pageSize?: number;
    cursor?: string;
    orderBy?: "updated_at" | "name";
    direction?: string;
    user?: string;
    status?:
        | "imx"
        | "eth"
        | "preparing_withdrawal"
        | "withdrawable"
        | "burned";
    name?: string;
    metadata?: string;
    sellOrders?: boolean;
    buyOrders?: boolean;
    includeFees?: boolean;
    collection?: string;
    updatedMinTimestamp?: string;
    updatedMaxTimestamp?: string;
    auxiliaryFeePercentages?: string;
    auxiliaryFeeRecipients?: string;
}

Hierarchy

  • AssetsApiListAssetsRequest
    • AssetsApiListAssetsRequest

Properties

pageSize? cursor? orderBy? direction? user? status? name? metadata? sellOrders? buyOrders? includeFees? collection? updatedMinTimestamp? updatedMaxTimestamp? auxiliaryFeePercentages? auxiliaryFeeRecipients?

Properties

Optional ReadonlypageSize

pageSize?: number

Page size of the result

Memberof

AssetsApiListAssets

Optional Readonlycursor

cursor?: string

Cursor

Memberof

AssetsApiListAssets

Optional ReadonlyorderBy

orderBy?: "updated_at" | "name"

Property to sort by

Memberof

AssetsApiListAssets

Optional Readonlydirection

direction?: string

Direction to sort (asc/desc)

Memberof

AssetsApiListAssets

Optional Readonlyuser

user?: string

Comma separated list of ethereum address of the users who own these assets

Memberof

AssetsApiListAssets

Optional Readonlystatus

status?:
    | "imx"
    | "eth"
    | "preparing_withdrawal"
    | "withdrawable"
    | "burned"

Status of these assets

Memberof

AssetsApiListAssets

Optional Readonlyname

name?: string

Name of the asset to search

Memberof

AssetsApiListAssets

Optional Readonlymetadata

metadata?: string

URL JSON-encoded metadata filters for these assets. Javascript example: encodeURI(JSON.stringify({'proto':['1147'],'quality':['Meteorite']}))

Memberof

AssetsApiListAssets

Optional ReadonlysellOrders

sellOrders?: boolean

Set flag to true to fetch an array of sell order details with accepted status associated with the asset

Memberof

AssetsApiListAssets

Optional ReadonlybuyOrders

buyOrders?: boolean

Set flag to true to fetch an array of buy order details with accepted status associated with the asset

Memberof

AssetsApiListAssets

Optional ReadonlyincludeFees

includeFees?: boolean

Set flag to include fees associated with the asset

Memberof

AssetsApiListAssets

Optional Readonlycollection

collection?: string

Comma separated list of the collections contract address

Memberof

AssetsApiListAssets

Optional ReadonlyupdatedMinTimestamp

updatedMinTimestamp?: string

Minimum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

AssetsApiListAssets

Optional ReadonlyupdatedMaxTimestamp

updatedMaxTimestamp?: string

Maximum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

AssetsApiListAssets

Optional ReadonlyauxiliaryFeePercentages

auxiliaryFeePercentages?: string

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

Memberof

AssetsApiListAssets

Optional ReadonlyauxiliaryFeeRecipients

auxiliaryFeeRecipients?: string

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

Memberof

AssetsApiListAssets

Settings

Member Visibility

On This Page

Properties
""