Hercle
REST
GET/api/v1/user/trades/{tradeClientId}

Get Trades by ClientId

Retrieve all trades associated with a specific client identifier.

Auth:Bearer <api_key>
Tags:Trades

Request

cURL
curl -G https://publicapi.sandbox.hercle.financial/api/v1/user/trades/{tradeClientId} \
  -H "Authorization: Bearer eyJhb..." \
  

Path Parameters

NameTypeRequiredDescription
clientIdstringYesUnique client identifier to filter trades
Example: HercleX

Headers

NameTypeRequiredDescription
AuthorizationstringYesBearer token for authentication

Response

Success Response Schema

FieldTypeDescription
idstringUnique identifier for the trade
clientIdstringClient identifier associated with the trade
userIdstringUser identifier who executed the trade
instrumentstringTrading instrument (e.g., BTC/USDT)
sidestring
Trade side
Allowed values:
buy
sell
pricenumberExecution price
quantityFillednumberQuantity filled in the trade
timestampstringISO 8601 timestamp of trade execution
emailstringEmail address of the user

Responses

List of trades retrieved successfully

200 application/json
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "clientId": "client_001",
    "userId": "987e6543-e21b-12d3-a456-426614174001",
    "instrument": "BTC/USDT",
    "side": "buy",
    "price": 50000,
    "quantityFilled": 0.1,
    "timestamp": "2024-06-01T12:00:00Z",
    "email": "john.doe@example.com"
  }
]

API Tester

Test this endpoint directly against the sandbox environment

Get your API key from Hercle Sandbox

Unique client identifier to filter trades

https://publicapi.sandbox.hercle.financial/api/v1/user/trades/{tradeClientId}