---
title: "Retrieve list of exchange orders"
method: GET
path: "/exchange/api/orders"
tags: ["exchange-external-api"]
---

# Retrieve list of exchange orders

`GET /exchange/api/orders`

## Query parameters

- `from` string, date
- `to` string, date
- `size` integer
- `page` integer
- `transactionType` 'ONRAMP' | 'OFFRAMP'
- `statuses` GetExchangeOrdersExternalStatusesEnum[]
- `token` string
- `fiat` string
- `network` string

## Response `200`

Success

- ExchangeOrdersResponse
  - `orders` ExchangeOrderDTO[]
    - `id` string, uuid
    - `cexOrderId` integer
    - `apiKey` string
    - `lastWebhookSentAt` string, date-time — Timestamp field.
    - `orderId` string, uuid
    - `reference` string
    - `customerId` string, uuid
    - `customerName` string
    - `offer` OrderOfferDTO
      - `offerId` string, uuid
      - `partnerId` string, uuid, required
      - `transactionType` 'ONRAMP' | 'OFFRAMP', required
      - `rate` number, required
      - `networkId` string, required
      - `fiatSymbol` string
      - `fiatAmount` number
      - `token` string, required
      - `tokenAmount` number, required
      - `partnerDisplayName` string
    - `escrowAddress` string — Escrow address
    - `paymentChannelId` string
    - `paymentMethod` object
    - `buyerPaymentMethod` object
    - `customerWallet` WalletDTO
      - `walletAddress` string
      - `networkId` string
      - `walletName` string
    - `tokenAddress` string
    - `status` 'INITIATED' | 'DEPOSITED' | 'CONFIRMED' | 'COMPLETED' | 'PENDING' | 'CANCELLED' | 'IN_DISPUTE' | 'AWAITING_ACCEPTANCE'
    - `createdAt` string, date-time — Timestamp field.
    - `initiatedAt` string, date-time — Timestamp field.
    - `depositedAt` string, date-time — Timestamp field.
    - `confirmedAt` string, date-time — Timestamp field.
    - `completedAt` string, date-time — Timestamp field.
    - `cancelledAt` string, date-time — Timestamp field.
    - `lockHash` string
    - `confirmationHash` string
    - `cancellationHash` string
  - `pageNumber` integer
  - `pageSize` integer
  - `totalPages` integer
  - `totalOrders` integer

## Other responses

- `400` — Bad request
- `401` — Unauthorized request
- `500` — Server error

---

[API](https://skmtc.net/nestechops/apis/onboard-external-api-gateway.md) · [All operations](https://skmtc.net/nestechops/apis/onboard-external-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nestechops/onboard-external-api-gateway/revisions/29661adc1ffc/schema)
