Get Matched Orders

This endpoint retrieves matched orders based on various filters. It is useful for obtaining detailed information about orders that have been successfully matched within a specified time frame.

Endpoint

GET /api/v1/matched-orders

Headers

Authorization: Bearer Token (required)

Query Parameters

external_user_id: Filter by external user ID (optional)
order_id: Filter by order ID (optional)
from: Start of the time range (Unix timestamp, optional)
to: End of the time range (Unix timestamp, optional)
cursor: Pagination cursor (optional)
limit: Number of records to return (default 20, max 100, optional)

Responses

200 OK: Successful retrieval of matched orders
- Content: JSON object containing matched orders data
400 Bad Request: Invalid request parameters
401 Unauthorized: Missing or invalid authentication token
500 Internal Server Error: Server encountered an unexpected condition

Example Request

GET /api/v1/matched-orders?external_user_id=12345&from=1609459200&to=1612137600 HTTP/1.1
Host: api-ss-sandbox.betprophet.co
Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": 1,
        "order_id": "order123",
        "external_user_id": "user123",
        "stake": 100.0,
        "profit": 50.0,
        "status": "matched"
      }
    ],
    "pagination": {
      "has_next_page": false,
      "limit": 20,
      "next_cursor": null
    }
  }
}

This documentation provides a clear and concise overview of the Get Matched Orders endpoint, detailing its purpose, usage, and expected responses.