Blockfrost.io OpenAPI

Open Source OpenAPI specification for Blockfrost.io backend API.

Getting started • Development

Getting started

The development version is available in the master branch.
The latest active release can be found under GitHub Releases.
For the published documentation, visit docs.blockfrost.io.

Development

Blockfrost OpenAPI blockfrost-openapi.yaml specification is generated from all yaml files in src directory. Then there is Mithril Aggregator API spec mithril.yaml which can be downloaded from Mithril Github. These two specs are then merged together via openapi-merge-cli (configuration is inside openapi-merge.json). Only the Mithril endpoints with a tag Cardano » Mithril are included into the final spec.

Tag Cardano » Mithril needs to be added manually to each relevant endpoint in Mithril OpenAPI spec.

If you add a new file then don't forget to add it to paths in src/definitions.yaml.

Edit the source yaml files and build the package:

yarn build

Midnight GraphQL docs

The Midnight Indexer GraphQL API documentation is generated using SpectaQL from the schema file midnight-indexer-api.graphql. The SpectaQL configuration is in spectaql.yaml and the custom theme is in spectaql-theme/.

To update the GraphQL schema, download the version matching the deployed Midnight Indexer from the Midnight Indexer repository and replace the local file:

Then rebuild with yarn bundle (SpectaQL runs as part of the bundle step) to regenerate the docs in docs/midnight/.

Feel free to open PR against the master branch. It is a great place to start any discussion for new features and changes to the Blockfrost API.

UI

When you push a new commit, the documentation for your branch is automatically generated on Vercel and added to your PR as a deployment.

Usage

You can download openapi.yaml directly from the repository or use this project as a dependency in your JavaScript/TypeScript project.

Typescript example

Install @blockfrost/openapi:

yarn add @blockfrost/openapi

or

npm install @blockfrost/openapi

Now you can use TypeScript types generated from the OpenAPI specification:

import { components } from '@blockfrost/openapi';

type Block = components['schemas']['block_content'];
type Address = components['schemas']['address_content'];
type UtxoAsset = components['schemas']['address_utxo_content'];