API Reference
The API reference is built from 16 OpenAPI 3.1 files, one per area. They hold the 86 operations you can call with an API key. Download them to import into an API client, generate typed code, or check your requests in tests.
Example. You want typed models for transfers. You download openapi/transfer.yaml, generate a client from it, and point it at https://api.gravv.xyz with your sandbox key in the Api-Key header. A misspelled field name now shows up before you send the request, and the response models carry the {data, error} envelope.
The files
Using them
- Every file has the server
https://api.gravv.xyzand theApi-Keyheader as its security scheme. Your key decides sandbox or live. - Paths carry their version,
/v1/…or/v2/…. - The files are separate. They share no schemas, so a generator makes one set of models per file.
- Responses show the
{data, error}envelope and the documented400errors, including not-found. - Some fields carry
x-not-yet-live: true, and some values appear inx-not-yet-live-values. The live API refuses them or never returns them today. Leave them out of your requests. - Each operation's page in this reference also lists the rules a schema cannot express, such as which fields go together and what sandbox returns. Read it before you rely on a generated client alone.
- The files change when the API reference changes. Download them again when you update your integration, and check the changelog.
Was this page helpful?