{"id":22437060,"url":"https://github.com/blockfrost/openapi","last_synced_at":"2025-04-05T18:06:12.506Z","repository":{"id":38202596,"uuid":"326194912","full_name":"blockfrost/openapi","owner":"blockfrost","description":"OpenAPI specification for Blockfrost.io service","archived":false,"fork":false,"pushed_at":"2025-03-26T15:37:59.000Z","size":7291,"stargazers_count":23,"open_issues_count":11,"forks_count":18,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T17:06:10.385Z","etag":null,"topics":["blockfrost","cardano","openapi"],"latest_commit_sha":null,"homepage":"https://docs.blockfrost.io","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blockfrost.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-02T14:01:54.000Z","updated_at":"2025-03-26T14:45:03.000Z","dependencies_parsed_at":"2023-11-22T13:47:44.912Z","dependency_job_id":"7fd782e1-f6a6-47d9-8986-34690ffcae96","html_url":"https://github.com/blockfrost/openapi","commit_stats":{"total_commits":545,"total_committers":13,"mean_commits":41.92307692307692,"dds":0.7064220183486238,"last_synced_commit":"56889afb972800e0e5b8c280c04d3d7f439e9f01"},"previous_names":[],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockfrost%2Fopenapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockfrost%2Fopenapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockfrost%2Fopenapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockfrost%2Fopenapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blockfrost","download_url":"https://codeload.github.com/blockfrost/openapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247378140,"owners_count":20929296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockfrost","cardano","openapi"],"created_at":"2024-12-06T00:11:29.051Z","updated_at":"2025-04-05T18:06:12.479Z","avatar_url":"https://github.com/blockfrost.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://blockfrost.io/images/logo.svg\" width=\"250\" align=\"right\" height=\"90\" style=\"margin-bottom: -50px\"\u003e\n\n# Blockfrost.io OpenAPI\n\n\u003cbr\u003e\n\u003cp align=\"center\"\u003eOpen Source OpenAPI specification for \u003ca href=\"https://blockfrost.io\"\u003eBlockfrost.io\u003c/a\u003e backend API.\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n![GitHub](https://img.shields.io/github/license/blockfrost/openapi)\n![master build ci](https://github.com/blockfrost/openapi/actions/workflows/CI.yaml/badge.svg?branch=master)\n[![npm version](https://badge.fury.io/js/%40blockfrost%2Fopenapi.svg)](https://badge.fury.io/js/%40blockfrost%2Fopenapi)\n![downloads](https://img.shields.io/npm/dy/@blockfrost/openapi)\n\u003ca href=\"https://fivebinaries.com/\"\u003e\u003cimg src=\"https://img.shields.io/badge/made%20by-Five%20Binaries-darkviolet.svg?style=flat-square\" /\u003e\u003c/a\u003e\n\n\u003c/div\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#getting-started\"\u003eGetting started\u003c/a\u003e •\n  \u003ca href=\"#development\"\u003eDevelopment\u003c/a\u003e\n\u003c/p\u003e\n\n## Getting started\n\nActive version can be found in `released` branch and also in [GitHub releases](https://github.com/blockfrost/openapi/releases).\n\nDevelopment version is in `master` branch and is being merged into `released` upon each release.\n\nReleased documentation can be found at [docs.blockfrost.io](https://docs.blockfrost.io/).\n\n## Development\n\nBlockfrost OpenAPI [`blockfrost-openapi.yaml`](blockfrost-openapi.yaml) specification is generated from all yaml files in `src` directory.\nThen there is Mithril Aggregator API spec [`mithril.yaml`](mithril.yaml) which can be downloaded from [Mithril Github](https://github.com/input-output-hk/mithril).\nThese two specs are then merged together via `openapi-merge-cli` (configuration is inside [`openapi-merge.json`](openapi-merge.json)).\nOnly the Mithril endpoints with a tag `Cardano » Mithril` are included into the final spec.\n\n\u003e Tag `Cardano » Mithril` needs to be added manually to each relevant endpoint in Mithril OpenAPI spec.\n\nIf you add a new file then don't forget to add it to `paths` in [`src/definitions.yaml`](src/definitions.yaml).\n\nEdit the source yaml files and build the package:\n\n```typescript\nyarn build\n```\n\nFeel 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.\n\n### UI\n\nWhen you push a new commit, the documentation for your branch is automatically generated on Vercel and added to your PR as a deployment.\n\n## Usage\n\nYou can download [`openapi.yaml`](openapi.yaml) directly from the repository or use this project as a dependency in your JavaScript/TypeScript project.\n\n### Typescript example\n\nInstall `@blockfrost/openapi`:\n\n```console\nyarn add @blockfrost/openapi\n```\n\nor\n\n```console\nnpm install @blockfrost/openapi\n```\n\nNow you can use TypeScript types generated from the OpenAPI specification:\n\n```typescript\nimport { components } from '@blockfrost/openapi';\n\ntype Block = components['schemas']['block_content'];\ntype Address = components['schemas']['address_content'];\ntype UtxoAsset = components['schemas']['address_utxo_content'];\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblockfrost%2Fopenapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblockfrost%2Fopenapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblockfrost%2Fopenapi/lists"}