Get a margin call

Requires scope facility:read.

The same record the margin_call.started webhook announced, including instructions. Fetching is what makes the webhook non-critical: a delivery that was missed, arrived out of order, or was dropped by a proxy does not strand the broker, because the instruction set can always be read back from here.

Addressed by number, the margin call's position on this facility, which is what the webhook carries alongside facility_id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
integer
required
≥ 1

The margin call's position on this facility, from 1. Scoped to the facility, so number 2 on one facility and number 2 on another are different records — facility_id is always part of the key.

Headers
string
required
^[0-9]{10}$

Unix seconds. Requests outside a ±5 minute window are rejected, and the value is part of the signed canonical request.

string
required
length between 88 and 88
^[A-Za-z0-9+/]{86}==$

Base64 of the Ed25519 signature over the canonical request. Ed25519 signatures are always 64 bytes, so this is always 88 characters ending in ==.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json