Get Orders

This is the partner API for fetching orders.

Filtering: Get Orders supports filters such as filter[status], filter[sortOrder], filter[walletAddress], and filter[productsAvailed], plus exact match on filter[partnerOrderId].

filter[productsAvailed] must be passed as a JSON-encoded array string such as ["BUY"] or ["SELL"].

Pagination: Respect limit and skip to avoid large responses.

get/orders

Request

  • Base URL: https://api-stg.transak.com/partners/api/v2
  • URL: https://api-stg.transak.com/partners/api/v2/orders
  • Auth: none declared. Required headers: x-api-key, access-token

Query parameters

limitinteger

limits the number of records returned.

skipinteger

skip omits the specified number of returned records

startDatestring

startDate in YYYY-MM-DD format. Default to 90 days prior to current date

endDatestring

endDate in YYYY-MM-DD format. Defaults to current date

filter[productsAvailed]string

JSON-encoded array string for products availed, for example ["BUY"] or ["SELL"]

filter[status]string

order status filter

filter[sortOrder]string

sort order by which you want your orders either desc or asc

filter[walletAddress]string

filter orders based on a wallet address. Note: Returns BUY orders only

filter[partnerOrderId]string

filter orders based on a partnerOrderId parameter

Headers

x-api-keystring required

Your Partner API key. You can find this in the Partner Dashboard.

access-tokenstring required

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

Response

Orders fetched successfully

Changes

No recorded changes to this operation across all 1 revision of this API.