Interface TransfersApiListTransfersRequest

interface TransfersApiListTransfersRequest {
    pageSize?: number;
    cursor?: string;
    orderBy?:
        | "created_at"
        | "transaction_id"
        | "sender_ether_key"
        | "receiver_ether_key";
    direction?: string;
    user?: string;
    receiver?: string;
    status?: "success" | "failure";
    minTimestamp?: string;
    maxTimestamp?: string;
    tokenType?: string;
    tokenId?: string;
    assetId?: string;
    tokenAddress?: string;
    tokenName?: string;
    minQuantity?: string;
    maxQuantity?: string;
    metadata?: string;
}

Hierarchy

  • TransfersApiListTransfersRequest
    • TransfersApiListTransfersRequest

Properties

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

Properties

Optional ReadonlypageSize

pageSize?: number

Page size of the result

Memberof

TransfersApiListTransfers

Optional Readonlycursor

cursor?: string

Cursor

Memberof

TransfersApiListTransfers

Optional ReadonlyorderBy

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

Property to sort by

Memberof

TransfersApiListTransfers

Optional Readonlydirection

direction?: string

Direction to sort (asc/desc)

Memberof

TransfersApiListTransfers

Optional Readonlyuser

user?: string

Ethereum address of the user who submitted this transfer

Memberof

TransfersApiListTransfers

Optional Readonlyreceiver

receiver?: string

Ethereum address of the user who received this transfer

Memberof

TransfersApiListTransfers

Optional Readonlystatus

status?: "success" | "failure"

Status of this transfer

Memberof

TransfersApiListTransfers

Optional ReadonlyminTimestamp

minTimestamp?: string

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

Memberof

TransfersApiListTransfers

Optional ReadonlymaxTimestamp

maxTimestamp?: string

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

Memberof

TransfersApiListTransfers

Optional ReadonlytokenType

tokenType?: string

Token type of the transferred asset

Memberof

TransfersApiListTransfers

Optional ReadonlytokenId

tokenId?: string

ERC721 Token ID of the minted asset

Memberof

TransfersApiListTransfers

Optional ReadonlyassetId

assetId?: string

Internal IMX ID of the minted asset

Memberof

TransfersApiListTransfers

Optional ReadonlytokenAddress

tokenAddress?: string

Token address of the transferred asset

Memberof

TransfersApiListTransfers

Optional ReadonlytokenName

tokenName?: string

Token name of the transferred asset

Memberof

TransfersApiListTransfers

Optional ReadonlyminQuantity

minQuantity?: string

Max quantity for the transferred asset

Memberof

TransfersApiListTransfers

Optional ReadonlymaxQuantity

maxQuantity?: string

Max quantity for the transferred asset

Memberof

TransfersApiListTransfers

Optional Readonlymetadata

metadata?: string

JSON-encoded metadata filters for the transferred asset

Memberof

TransfersApiListTransfers

Settings

Member Visibility

On This Page

Properties