Skip to main content
GET
Returns a PDF statement covering the market’s configuration, roles, encumbrances, loans, liquidations and auctions, assembled from indexed on-chain events. Use it for reporting and audit rather than for programmatic reads.
This endpoint does not return the JSON envelope. On success it responds with Content-Type: application/pdf and a Content-Disposition: attachment header carrying the generated filename. Errors are returned as the usual JSON envelope, so branch on the response content type rather than parsing unconditionally.
This endpoint counts against the write rate limit rather than the read limit. See Rate Limits.

Path Parameters

string
required
Market ID.

Query Parameters

string
Comma-separated sections to include. Any of config, roles, encumbrances, loans, liquidations, auctions. Omit for all six. Maximum 200 characters. Unknown names are rejected.
string
Restrict the statement to a single loan. A positive integer of at most 18 digits.
string
Start of the reporting window as YYYY-MM-DD. Not earlier than 2015-01-01.
string
End of the reporting window as YYYY-MM-DD, inclusive. Must not be earlier than from.

Response

A PDF document. The filename is set by the server on the Content-Disposition header and identifies the market and the reporting window.

Error Codes