Tools

Request builder

Pick an operation, fill in the parameters and body fields, and copy the request in nine languages. Every field carries its type, whether it is required and an example from the API description.

Runs in your browser - nothing is sent, keys stay in your environment
Reference →
GET/api/external/v1/meThe key you are calling with
Auth X-Api-KeyPartner API

Request

The API host of your installation; https://api.your-brand.com is a placeholder.

The key is read from OCTOLIT_PARTNER_KEY in the samples (pk_live_...), so no secret is typed here.

No parameters - just send it.
Ready to sendGET /me
URL
https://api.your-brand.com/api/external/v1/me
curl "https://api.your-brand.com/api/external/v1/me" \
  -H "X-Api-Key: $OCTOLIT_PARTNER_KEY"

Samples are generated from what you typed - the same generator as the reference pages. Replace the env var with your key; nothing is sent from this page.

#How it works

  • The operation list, parameters and examples come from the published OpenAPI documents (see downloads); 56 operations across the Partner API and the Trading API.
  • Empty optional fields are left out of the request. Numbers and booleans are sent as JSON numbers and booleans; everything else as strings.
  • The API key is never typed here: the samples read it from an environment variable (OCTOLIT_PARTNER_KEY or OCTOLIT_API_KEY) and send it in the X-Api-Key header.
Base URL
Replace https://api.your-brand.com with the API host of your installation. Order actions also need a client_order_id (body or Idempotency-Key header) so a retry never places a second order.