Retrieve a list of orders

get

https://api.banxa.com/{partner}/v2/orders

Retrieves details for a bulk of orders that have been submitted within a given time range and optionally by order status or customer.

Path Params

partner

string

required

This is the partner code provided to you during onboarding. e.g. metamask.

Query Params

start

string

required

The start date of the dataset in UTC. This is inclusive: orders created at this exact date will be included.

end

string

required

The end date of the dataset in UTC. This is inclusive: orders created at this exact date will be included.

skip

string

The number of orders to skip in the dataset.

page

string

The page of orders that are returned.

externalCustomerId

string

Indicates the customer identifier that was used when creating the order. Orders will be filtered based on orders made by this customer.

status

string

Indicates the current status of the order. One or many statuses can be passed.

limit

string

The limit of orders that are returned. If not provided, then default to 100 records.

Headers

string

Defaults to application/json

x-api-key

string

This is the API Key that has been provided to you during onboarding.

Response

Language

Loading…

Response

Choose an example:

application/json

200200