Retrieve Deal Information

get

https://secure.sandbox.platcore.io/deals/{id}

This method returns detailed information about a specific deal identified by its unique ID.
Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123.

Responses

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "ORD123456",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "currencyFrom": { ... },
  "currencyTo": { ... },
  "exchangePair": "BTC/USD",
  "direction": "C2F",
  "amount": 1000.00,
  "status": { ... },
  "amounts": { ... },
  "metadata": { ... }
}

{
  "error": "ERROR_ACCESS_TOKEN_INVALID",
  "message": "Access token is invalid.",
  "statusCode": 400
}

{
  "error": "ERROR_TOKEN_EXPIRED",
  "message": "Access token has expired.",
  "statusCode": 401
}

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved the deal information. Example response: JSON

400Invalid request, typically due to a missing or malformed parameter. Example response: JSON

401Authentication failed. This may happen due to the following reasons: Authentication is required but not provided. The access token has expired. Example response: JSON