{"id":21809476,"url":"https://github.com/lepetitbloc/bitcoin-swagger","last_synced_at":"2025-07-15T16:11:42.794Z","repository":{"id":57189750,"uuid":"128763861","full_name":"LePetitBloc/bitcoin-swagger","owner":"LePetitBloc","description":"Bitcoind Rest API Swagger specification document (OpenAPI)","archived":false,"fork":false,"pushed_at":"2018-04-24T12:58:20.000Z","size":8985,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-08T19:05:17.131Z","etag":null,"topics":["bitcoin","openapi","swagger"],"latest_commit_sha":null,"homepage":"https://lepetitbloc.github.io/bitcoin-swagger/","language":"HTML","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/LePetitBloc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-09T11:50:59.000Z","updated_at":"2024-05-16T21:15:49.000Z","dependencies_parsed_at":"2022-09-15T06:41:24.816Z","dependency_job_id":null,"html_url":"https://github.com/LePetitBloc/bitcoin-swagger","commit_stats":null,"previous_names":["lepetitbloc/bitcoin-openapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LePetitBloc/bitcoin-swagger","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LePetitBloc%2Fbitcoin-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LePetitBloc%2Fbitcoin-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LePetitBloc%2Fbitcoin-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LePetitBloc%2Fbitcoin-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LePetitBloc","download_url":"https://codeload.github.com/LePetitBloc/bitcoin-swagger/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LePetitBloc%2Fbitcoin-swagger/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265444925,"owners_count":23766437,"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":["bitcoin","openapi","swagger"],"created_at":"2024-11-27T13:22:00.574Z","updated_at":"2025-07-15T16:11:42.762Z","avatar_url":"https://github.com/LePetitBloc.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bitcoin OpenAPI specification (swagger)\n**Bitcoin** Rest API swagger specification document in Yml and Json (OpenAPI).\n\n\u003e The current version uses the Version 2.0 of the OpenAPI Specification:\n\u003e https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md\n\n## Usage\nYou can import the YML/Json file in the [Swagger editor](http://editor.swagger.io/) and generate a client for any [supported languages](https://swagger.io/open-source-integrations/).\n\n## Clients\nA collection of pre-generated client repositories is available in the **bitcoind-rest** group:\nhttps://github.com/bitcoind-rest\n\n## Resources\n* Docs https://lepetitbloc.github.io/bitcoin-swagger/\n* Version 2.0 of the OpenAPI Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md\n* https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md\n\n## Common pitfalls\nBitcoin Rest API doesn't provide any mechanism to handle CORS. For the time being we recommend to setup an Nginx proxy in front of the **Bitcoin** Rest API.\n\n\u003e see the following PR on Bitcoin repository:\n\u003e [add support for CORS headers](https://github.com/bitcoin/bitcoin/pull/12040)\n\n## Development\n\u003e We're using a local [swagger-editor](https://github.com/swagger-api/swagger-editor) and a `bitcoind` binary running on the `testnet` to develop and live-test the specification file.\n\u003e You can start them both as containers with docker-composer.\n\n1. Start `bitcoind` and `swagger-editor` containers via `docker-compose`:\n```\ndocker-compose up\n```\n2. Visit http://localhost:3000\n3. Import `swagger.yml` from the *\u003e File \u003e Import file* menu in the GUI.\n\n\u003e **Note:** The YML file is used as the reference, the Json file is exported via the GUI.\n\n## Licence\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flepetitbloc%2Fbitcoin-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flepetitbloc%2Fbitcoin-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flepetitbloc%2Fbitcoin-swagger/lists"}