Skip to main content
Retrieves the details of a specific open order by order ID and user ID for a given market.

Endpoint

GET /api/v1/order

Request

Body parameters

user_id
string
required
The unique identifier of the user who owns the order
order_id
string
required
The unique identifier of the order to retrieve
market
string
required
The trading pair market (e.g., “SOL_USDC”, “BTC_USDT”)

Response

Success response

Returns the complete order object:
price
decimal
The limit price of the order
quantity
decimal
The total quantity of the order
filled_quantity
decimal
The quantity that has been filled
order_id
string
The unique identifier of the order
user_id
string
The unique identifier of the user who owns the order
side
string
The order side (“BUY” or “SELL”)
order_type
string
The type of order (“LIMIT” or “MARKET”)
order_status
string
The current status of the order (“Pending”, “Filled”, “PartiallyFilled”, or “Cancelled”)
timestamp
integer
The Unix timestamp in milliseconds when the order was created

Error response

status
string
Status message indicating the order retrieval failed

Example

curl -X GET http://localhost:8080/api/v1/order \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "user123",
    "order_id": "550e8400-e29b-41d4-a716-446655440000",
    "market": "SOL_USDC"
  }'
Success response:
{
  "price": "150.50",
  "quantity": "10.0",
  "filled_quantity": "3.5",
  "order_id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "user123",
  "side": "BUY",
  "order_type": "LIMIT",
  "order_status": "PartiallyFilled",
  "timestamp": 1727022600000
}
Error response:
{
  "status": "Failed to Retrieve Open Order"
}

Error codes

  • 200 OK - Order retrieved successfully
  • 500 Internal Server Error - Failed to retrieve the order or Redis connection error

Build docs developers (and LLMs) love