---
title: "List previously placed orders"
method: GET
path: "/orders"
tags: ["Orders"]
---

# List previously placed orders

`GET /orders`

Get a list of previously placed orders. Depending on the authentication
method used different orders will be returned.

When the `bity_account_oauth` or `bity_account_client_oauth` security
schemes are used, which orders are visible depends on the scope of the
access token.

## Query parameters

- `page` number
- `page_size` number
- `status` 'finalized' | 'ongoing'

## Response `200`

Successful operation.

- object
  - `orders` Order[], required
    - `client_value` integer — An arbitrary integer provided by the API client. The property is shown in the order details and in the reporting API.
    - `id` string, required — Unique identifier of the order.
    - `input` OrderInput, required — unresolved $ref
    - `message_to_sign` MessageToSign — A message to be signed. The signature must be sent in the body of a POST request to the URL specified by `signature_submission_url`. This endpoint returns a 204 status code uppon submission of a valid signature. The message must be encoded as UTF-8 and the resulting sequence of bytes signed. Make sure to keep the message intact, including all white spaces. Use "eth_sign" with Ethereum addresses and "signmessage" with Bitcoin addresses. Keep the signature in the format provided by those calls (at the time of writing it is an hexadecimal string for Ethereum and base64 string for Bitcoin).
      - `body` string, required
      - `signature_submission_url` string, required
    - `output` OrderOutput, required — unresolved $ref
    - `payment_details` union
      - PaymentDetailsBankAccount — Payment details when the input type is `bank_account`. The bank account information details contained in this object must be used to perform a bank transfer to pay the order.
        - `account_number` string
        - `bank_address` string
        - `bank_code` string
        - `iban` string, required — IBAN of the bank account to which the order must be paid.
        - `recipient` string — Do not use, this property is present for backward compatibility. Use `recipient_name` and `recipient_postal_address` instead.
        - `recipient_name` string, required — Name of the recipient of the payment.
        - `recipient_postal_address` string[], required — Postal address of the recipient of the payment.
        - `reference` string — The reference (also known as communication or message to the recipient) that must be included in the bank transfer.
        - `swift_bic` string — BIC code of the bank account to which the order must be paid.
        - `type` 'bank_account', required
      - PaymentDetailsCryptoAddress — Payment details when the input type is `crypto_address`.
        - `crypto_address` string, required — Crypto-address to which to send the payment for the order.
        - `memo` string — When this property is present, the crypto-transaction paying the order must include this exact value as the memo.
        - `type` 'crypto_address', required
      - PaymentDetailsOnlineInstantPayment — Payment details when then input type is `online_instant_payment`.
        - `payment_ui_url` string, required
        - `type` 'online_instant_payment', required
    - `price_breakdown` PriceBreakdown, required
      - `customer_trading_fee` object — The customer trading fee applied to this order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `instant_payment_fee` object — The instant payment fee applied to this order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `non-verified_fee` object — The non-verified fee applied to this order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `output_transaction_cost` object — Execution cost of the output transaction. Includes crypto transaction fees, bank transaction fees, etc.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `partner_fee` object — -> Additional fee perceived on behalf of the partner having placed the order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
    - `purpose` OrderPurpose — Information about the purpose of the order.
      - `category` string — Non-exhaustive list of possible values: - `bill_payment`: The purpose of the order is to pay a bill.
      - `comment` string — Comment about the purpose of the order. Users can use this comment in order to remember what was their purpose when placing the order.
    - `timestamp_awaiting_payment_since` string, date-time — Date and time at which the order became executable and at which the payment information was made available.
    - `timestamp_cancelled` string, date-time — Date and time at which the order was cancelled.
    - `timestamp_created` string, date-time, required — Date and time at which the client submitted the initial information regarding this order.
    - `timestamp_executed` string, date-time — Date and time at which the output amount was sent.
    - `timestamp_payment_received` string, date-time — Date and time at which the input amount is confirmed to have been received.
    - `timestamp_price_guaranteed` string, date-time — When present, the price is locked until the current time exceeds that particular timestamp. If the payment of the appropriate input amount is received before the indicated time, then the currently shown output amount will be sent. If the payment is received at a later time, execution of the order will use the market price instead. When absent, indicates that the price has not been locked yet.
  - `pagination` Pagination
    - `current` number, required — Current page number
    - `first` number — Page number of the first page
    - `last` number — Page number of the last page

## Other responses

- `429` — Rate-limited (request ignored)

---

[API](https://skmtc.dev/bity/apis/bity-exchange-api.md) · [All operations](https://skmtc.dev/bity/apis/bity-exchange-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bity/bity-exchange-api/revisions/fd48443fbac2/schema)