GET
/
orders
Get all orders.
curl --request GET \
  --url https://{environment}.garden.finance/v2/orders \
  --header 'garden-app-id: <api-key>'
{
  "status": "Ok",
  "error": "<string>",
  "result": [
    {
      "order_id": "<string>",
      "created_at": "<string>",
      "source_swap": {
        "created_at": "<string>",
        "swap_id": "<string>",
        "chain": "bitcoin",
        "asset": "bitcoin:btc",
        "initiator": "<string>",
        "redeemer": "<string>",
        "delegate": "<string>",
        "timelock": 123,
        "filled_amount": "<string>",
        "asset_price": 123,
        "amount": "<string>",
        "secret_hash": "<string>",
        "secret": "<string>",
        "instant_refund_tx": "<string>",
        "initiate_tx_hash": "<string>",
        "redeem_tx_hash": "<string>",
        "refund_tx_hash": "<string>",
        "initiate_block_number": "<string>",
        "redeem_block_number": "<string>",
        "refund_block_number": "<string>",
        "required_confirmations": 123,
        "current_confirmations": 123,
        "initiate_timestamp": "<string>",
        "redeem_timestamp": "<string>",
        "refund_timestamp": "<string>"
      },
      "destination_swap": {
        "created_at": "<string>",
        "swap_id": "<string>",
        "chain": "bitcoin",
        "asset": "bitcoin:btc",
        "initiator": "<string>",
        "redeemer": "<string>",
        "delegate": "<string>",
        "timelock": 123,
        "filled_amount": "<string>",
        "asset_price": 123,
        "amount": "<string>",
        "secret_hash": "<string>",
        "secret": "<string>",
        "instant_refund_tx": "<string>",
        "initiate_tx_hash": "<string>",
        "redeem_tx_hash": "<string>",
        "refund_tx_hash": "<string>",
        "initiate_block_number": "<string>",
        "redeem_block_number": "<string>",
        "refund_block_number": "<string>",
        "required_confirmations": 123,
        "current_confirmations": 123,
        "initiate_timestamp": "<string>",
        "redeem_timestamp": "<string>",
        "refund_timestamp": "<string>"
      },
      "slippage": 0.5,
      "nonce": "<string>",
      "affiliate_fees": [
        {
          "address": "<string>",
          "asset": "ethereum:cbbtc",
          "fee": 0.1
        }
      ],
      "integrator": "<string>",
      "version": "<string>"
    }
  ]
}

Retrieve a list of orders with optional filtering and pagination.

Authorizations

​
garden-app-id
string
header
required

If you do not yet have an APP ID, please follow these steps.

Response

200 - application/json

List of orders.

The response is of type object.