Interface TransfersApiListTransfersRequest

Hierarchy

  • TransfersApiListTransfersRequest
    • TransfersApiListTransfersRequest

Properties

pageSize? cursor? orderBy? direction? user? receiver? status? minTimestamp? maxTimestamp? tokenType? tokenId? assetId? tokenAddress? tokenName? minQuantity? maxQuantity? metadata?

Properties

Optional Readonly pageSize

pageSize?: number

Page size of the result

Memberof

TransfersApiListTransfers

Optional Readonly cursor

cursor?: string

Cursor

Memberof

TransfersApiListTransfers

Optional Readonly orderBy

orderBy?: "created_at" | "transaction_id" | "sender_ether_key" | "receiver_ether_key"

Property to sort by

Memberof

TransfersApiListTransfers

Optional Readonly direction

direction?: string

Direction to sort (asc/desc)

Memberof

TransfersApiListTransfers

Optional Readonly user

user?: string

Ethereum address of the user who submitted this transfer

Memberof

TransfersApiListTransfers

Optional Readonly receiver

receiver?: string

Ethereum address of the user who received this transfer

Memberof

TransfersApiListTransfers

Optional Readonly status

status?: "success" | "failure"

Status of this transfer

Memberof

TransfersApiListTransfers

Optional Readonly minTimestamp

minTimestamp?: string

Minimum timestamp for this transfer, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

TransfersApiListTransfers

Optional Readonly maxTimestamp

maxTimestamp?: string

Maximum timestamp for this transfer, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z'

Memberof

TransfersApiListTransfers

Optional Readonly tokenType

tokenType?: string

Token type of the transferred asset

Memberof

TransfersApiListTransfers

Optional Readonly tokenId

tokenId?: string

ERC721 Token ID of the minted asset

Memberof

TransfersApiListTransfers

Optional Readonly assetId

assetId?: string

Internal IMX ID of the minted asset

Memberof

TransfersApiListTransfers

Optional Readonly tokenAddress

tokenAddress?: string

Token address of the transferred asset

Memberof

TransfersApiListTransfers

Optional Readonly tokenName

tokenName?: string

Token name of the transferred asset

Memberof

TransfersApiListTransfers

Optional Readonly minQuantity

minQuantity?: string

Max quantity for the transferred asset

Memberof

TransfersApiListTransfers

Optional Readonly maxQuantity

maxQuantity?: string

Max quantity for the transferred asset

Memberof

TransfersApiListTransfers

Optional Readonly metadata

metadata?: string

JSON-encoded metadata filters for the transferred asset

Memberof

TransfersApiListTransfers

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc