imx-core-sdk-kotlin-jvm/com.immutable.sdk.api/OrdersApi/listOrders

listOrders

fun listOrders(pageSize: Int? = null, cursor: String? = null, orderBy: String? = null, direction: String? = null, user: String? = null, status: String? = null, minTimestamp: String? = null, maxTimestamp: String? = null, updatedMinTimestamp: String? = null, updatedMaxTimestamp: String? = null, buyTokenType: String? = null, buyTokenId: String? = null, buyAssetId: String? = null, buyTokenAddress: String? = null, buyTokenName: String? = null, buyMinQuantity: String? = null, buyMaxQuantity: String? = null, buyMetadata: String? = null, sellTokenType: String? = null, sellTokenId: String? = null, sellAssetId: String? = null, sellTokenAddress: String? = null, sellTokenName: String? = null, sellMinQuantity: String? = null, sellMaxQuantity: String? = null, sellMetadata: String? = null, auxiliaryFeePercentages: String? = null, auxiliaryFeeRecipients: String? = null, includeFees: Boolean? = null): ListOrdersResponse
Content copied to clipboard

Get a list of orders Get a list of orders

Return

ListOrdersResponse

Parameters

pageSize

Page size of the result (optional)

cursor

Cursor (optional)

orderBy

Property to sort by (optional)

direction

Direction to sort (asc/desc) (optional)

user

Ethereum address of the user who submitted this order (optional)

status

Status of this order (optional)

minTimestamp

Minimum created at timestamp for this order, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z' (optional)

maxTimestamp

Maximum created at timestamp for this order, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z' (optional)

updatedMinTimestamp

Minimum updated at timestamp for this order, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z' (optional)

updatedMaxTimestamp

Maximum updated at timestamp for this order, in ISO 8601 UTC format. Example: '2022-05-27T00:10:22Z' (optional)

buyTokenType

Token type of the asset this order buys (optional)

buyTokenId

ERC721 Token ID of the asset this order buys (optional)

buyAssetId

Internal IMX ID of the asset this order buys (optional)

buyTokenAddress

Comma separated string of token addresses of the asset this order buys (optional)

buyTokenName

Token name of the asset this order buys (optional)

buyMinQuantity

Min quantity for the asset this order buys (optional)

buyMaxQuantity

Max quantity for the asset this order buys (optional)

buyMetadata

JSON-encoded metadata filters for the asset this order buys (optional)

sellTokenType

Token type of the asset this order sells (optional)

sellTokenId

ERC721 Token ID of the asset this order sells (optional)

sellAssetId

Internal IMX ID of the asset this order sells (optional)

sellTokenAddress

Comma separated string of token addresses of the asset this order sells (optional)

sellTokenName

Token name of the asset this order sells (optional)

sellMinQuantity

Min quantity for the asset this order sells (optional)

sellMaxQuantity

Max quantity for the asset this order sells (optional)

sellMetadata

JSON-encoded metadata filters for the asset this order sells (optional)

auxiliaryFeePercentages

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

auxiliaryFeeRecipients

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

includeFees

Set flag to true to include fee object for orders (optional)

Throws

If the API returns an informational or redirection response

org.openapitools.client.infrastructure.ClientException

If the API returns a client error response

org.openapitools.client.infrastructure.ServerException

If the API returns a server error response