@blockfrost/openapi

Blockfrost.io OpenAPI

Open Source OpenAPI specification for Blockfrost.io backend API.

Getting started • Development

Getting started

Active version can be found in released branch and also in GitHub releases.

Development version is in master branch and is being merged into released upon each release.

Released documentation can be found at docs.blockfrost.io.

Development

openapi.yaml (located in the root directory) is generated from all yaml files in src directory. If you add a new file then don't forget to add it to paths in src/openapi.yaml.

Edit the source yaml files and bundle them:

yarn generate-types
yarn bundle

To build the documentation, run:

yarn geneate-docs

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.

Typescript example

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

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