Interface AssetsApiListAssetsRequest

Hierarchy

  • AssetsApiListAssetsRequest
    • AssetsApiListAssetsRequest

Properties

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

Properties

Optional Readonly pageSize

pageSize?: number

Page size of the result

Memberof

AssetsApiListAssets

Optional Readonly cursor

cursor?: string

Cursor

Memberof

AssetsApiListAssets

Optional Readonly orderBy

orderBy?: "name" | "updated_at"

Property to sort by

Memberof

AssetsApiListAssets

Optional Readonly direction

direction?: string

Direction to sort (asc/desc)

Memberof

AssetsApiListAssets

Optional Readonly user

user?: string

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

Memberof

AssetsApiListAssets

Optional Readonly status

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

Status of these assets

Memberof

AssetsApiListAssets

Optional Readonly name

name?: string

Name of the asset to search

Memberof

AssetsApiListAssets

Optional Readonly metadata

metadata?: string

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

Memberof

AssetsApiListAssets

Optional Readonly sellOrders

sellOrders?: boolean

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

Memberof

AssetsApiListAssets

Optional Readonly buyOrders

buyOrders?: boolean

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

Memberof

AssetsApiListAssets

Optional Readonly includeFees

includeFees?: boolean

Set flag to include fees associated with the asset

Memberof

AssetsApiListAssets

Optional Readonly collection

collection?: string

Comma separated list of the collections contract address

Memberof

AssetsApiListAssets

Optional Readonly updatedMinTimestamp

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 Readonly updatedMaxTimestamp

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 Readonly auxiliaryFeePercentages

auxiliaryFeePercentages?: string

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

Memberof

AssetsApiListAssets

Optional Readonly auxiliaryFeeRecipients

auxiliaryFeeRecipients?: string

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

Memberof

AssetsApiListAssets

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc