Get Orders Paginated

Retrieve a paginated list of OTC orders filtered by date range. Maximum date range is 30 days.

Auth:Bearer <api_key>

Tags:Orders

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/orders/{startDate}/{endDate}/{page}/{pageSize} \
  -H "Authorization: Bearer eyJhb..." \

Path Parameters

Name	Type	Required	Description
startDate	string	Yes	Start date for filtering orders (ISO 8601 format). Maximum range: 30 days from end date. Example: `2024-01-01T00:00:00Z`
endDate	string	Yes	End date for filtering orders (ISO 8601 format). Maximum range: 30 days from start date. Example: `2024-01-31T23:59:59Z`
page	number	Yes	Page number for pagination (starting from 0) Example: `0`
pageSize	number	Yes	Number of items per page (min: 5, max: 50) Example: `5`

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Success Response Schema

List of orders retrieved successfully

Field	Type	Description
`orderId`	string	Unique identifier for the order
`clientId`	string	Client identifier associated with the order
`userId`	string	User identifier who placed the order
`instrument`	string	Trading instrument (e.g., BTCUSD)
`base`	string	Base asset of the instrument (e.g., BTC)
`quote`	string	Quote asset of the instrument (e.g., USD)
`side`	string	Order side Allowed values: `buy` `sell`
`orderType`	number	Current type of the order `0`→ Market `1`→ Fill or Kill
`price`	number	Order price
`executedPrice`	number \| null	Actual execution price, or null
`executedTimestamp`	string \| null	ISO 8601 timestamp of order execution, or null
`quantity`	number	Requested order quantity
`quantityFilled`	number \| null	Quantity that was filled, or null
`orderStatus`	number	Current status of the order `0`→ Created `1`→ Executed `2`→ Cancelled `3`→ Pending
`cancellationReason`	string \| null	Reason for cancellation if applicable, or null
`slippage`	number	Maximum acceptable price slippage percentage
`timestamp`	string	ISO 8601 timestamp of order creation

Responses

List of orders retrieved successfully

200 application/json

[
  {
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "clientId": "client_001",
    "userId": "user_001",
    "instrument": "BTCUSD",
    "base": "BTC",
    "quote": "USD",
    "side": "buy",
    "orderType": 0,
    "price": 50000,
    "executedPrice": 49950,
    "executedTimestamp": "2024-06-01T12:00:00Z",
    "quantity": 0.1,
    "quantityFilled": 0.1,
    "orderStatus": 1,
    "cancellationReason": null,
    "slippage": 0.5,
    "timestamp": "2024-06-01T11:59:59Z"
  },
  {
    "orderId": "987e6543-e21b-12d3-a456-426614174001",
    "clientId": "client_001",
    "userId": "user_001",
    "instrument": "ETHUSD",
    "base": "ETH",
    "quote": "USD",
    "side": "sell",
    "orderType": 0,
    "price": 3000,
    "executedPrice": 3010,
    "executedTimestamp": "2024-06-02T14:30:00Z",
    "quantity": 1.5,
    "quantityFilled": 1.5,
    "orderStatus": 1,
    "cancellationReason": null,
    "slippage": 0.5,
    "timestamp": "2024-06-02T14:29:59Z"
  }
]

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Path Parameters

startDate

Required

Start date for filtering orders (ISO 8601 format). Maximum range: 30 days from end date.

endDate

Required

End date for filtering orders (ISO 8601 format). Maximum range: 30 days from start date.

page

Required

Page number for pagination (starting from 0)

pageSize

Required

Number of items per page (min: 5, max: 50)

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/orders/{startDate}/{endDate}/{page}/{pageSize}