API Reference

Ogmios as a JSON-WSP service is entirely described using JSON Schema - Draft 7. This can be fed into various tools to generate code, data-types or definitions in many languages. In particular, the server schema can be visualized here.

The schema is large (200+ type definitions!) for it covers everything there’s to cover in Cardano. If you get lost, look for the Ogmios object in the search bar to get back to the root of the schema!

If you’re using TypeScript, take a look at the API reference for the TypeScript client or more specifically, documentation for one of the Ouroboros mini-protocols clients:

Ogmios is tested against this JSON schema to make sure that it remains up-to-date as new features are added.

Download JSON Schema