Get integrator merchant ads

Retrieve merchant ads (limit orders, sweep orders, or market orders) for the authenticated integrator.

Single ad retrieval: Pass uid query parameter to fetch a specific ad by its unique identifier.
When fetching by UID, the ad's stored type is validated against the route's adType path parameter
(unless using the generic rate/rates route which accepts any type).

List retrieval: Omit uid to get a paginated list of all ads for the integrator.
Results can be filtered by side, pair, status, and date range.

Route behavior by adType:

  • rate / rates - Generic route. Returns any ad regardless of type. No type mismatch validation.
  • limit / limits - Only returns Limit (AD) type ads. Mismatch error for SWEEP/MARKET.
  • sweep / sweeps - Only returns SWEEP type ads. Mismatch error for AD/MARKET.
  • market / markets - Only returns MARKET type ads. Mismatch error for AD/SWEEP.

Invalid adType values return a 400 validation error.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

The type of ad to query. Both singular and plural forms are accepted.
rate/rates is a generic route that returns any ad type without mismatch validation.
limit/limits, sweep/sweeps, and market/markets enforce strict type matching.

Query Params
string

Unique identifier of a specific ad. When provided, returns a single ad. The ad must belong to the authenticated integrator.

integer
Defaults to 20

Number of ads to return per page (default 20)

string

Last evaluated key for pagination

string
enum

Filter by trade side

Allowed:
string

Filter by trading pair (e.g. BTC/USDT)

string
enum

Filter by ad status

Allowed:
date-time

Start date filter (ISO 8601)

date-time

End date filter (ISO 8601)

string

Filter by ad state (e.g. PUBLIC)

uuid

Required for admin requests when integratorPk is not in the authorizer

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json