Skip to main content
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": {
    "data": [
      {
        "order_id": "<string>",
        "created_at": "<string>",
        "source_swap": {
          "created_at": "<string>",
          "swap_id": "<string>",
          "chain": "arbitrum",
          "asset": "arbitrum:wbtc",
          "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": "arbitrum",
          "asset": "arbitrum:wbtc",
          "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>"
        },
        "nonce": "<string>",
        "affiliate_fees": [
          {
            "address": "<string>",
            "asset": "arbitrum:usdc",
            "fee": 10
          }
        ],
        "integrator": "<string>",
        "version": "<string>",
        "solver_id": "<string>"
      }
    ],
    "page": 123,
    "total_pages": 123,
    "total_items": 123,
    "per_page": 123
  }
}
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.

Query Parameters

​
address
string

(Optional) Filter orders by an address.

​
tx_hash
string

(Optional) Filter orders by a transaction hash.

​
from_chain

(Optional) Filter orders by the source chain. Mainnet

Available options:
arbitrum,
ethereum,
bitcoin,
base,
bnbchain,
botanix,
citrea,
hyperevm,
litecoin,
monad,
solana,
starknet,
tron
​
to_chain

(Optional) Filter orders by the destination chain. Mainnet

Available options:
arbitrum,
ethereum,
bitcoin,
base,
bnbchain,
botanix,
citrea,
hyperevm,
litecoin,
monad,
solana,
starknet,
tron
​
from_owner
string

(Optional) Filter orders by the source owner. Comma-separated for multiple values.

​
to_owner
string

(Optional) Filter orders by the destination owner. Comma-separated for multiple values.

​
solver_id
string

(Optional) Filter orders by a solver ID. Comma-separated for multiple values.

​
integrator
string

(Optional) Filter orders by an integrator. Comma-separated for multiple values.

​
page
integer

(Optional) Page number.

​
per_page
integer

(Optional) Number of items per page.

​
status
string

(Optional) Filter orders by status. Comma-separated string with allowed values: not-initiated, in-progress, completed, expired, refunded.

Response

200 - application/json

List of orders.

​
status
enum<string>
Available options:
Ok,
Error
​
error
string | null
​
result
object