{"id":18895656,"url":"https://github.com/binance/binance-api-swagger","last_synced_at":"2025-04-05T04:08:24.624Z","repository":{"id":39887270,"uuid":"404715166","full_name":"binance/binance-api-swagger","owner":"binance","description":"Swagger for the Binance Public API","archived":false,"fork":false,"pushed_at":"2024-10-08T09:05:11.000Z","size":6258,"stargazers_count":140,"open_issues_count":6,"forks_count":37,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-29T03:01:54.619Z","etag":null,"topics":["binance-api","crypto","openapi","swagger"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/binance.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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-09-09T12:34:40.000Z","updated_at":"2025-03-24T19:33:26.000Z","dependencies_parsed_at":"2023-11-15T07:26:05.451Z","dependency_job_id":"eb6962db-f6db-434b-bc74-6dadb69b47ae","html_url":"https://github.com/binance/binance-api-swagger","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-api-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-api-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-api-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-api-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/binance","download_url":"https://codeload.github.com/binance/binance-api-swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284941,"owners_count":20913704,"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":["binance-api","crypto","openapi","swagger"],"created_at":"2024-11-08T08:29:15.244Z","updated_at":"2025-04-05T04:08:24.585Z","avatar_url":"https://github.com/binance.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n# Binance Public API Swagger\n[Swagger](https://swagger.io/) is a set of tools around OpenAPI Specification that can help you design, build, document and consume REST APIs.\n\nBinance now offers a YAML collection file on [Binance Public Spot API](https://binance-docs.github.io/apidocs/spot/en/#change-log) to help developers' consulting of each endpoint through an interactive API documentation via Swagger UI.\n\n- Supported APIs:\n    - `/api/*`\n    - `/sapi/*`\n- Detailed parameters: mandatory or optional, descriptions and examples.\n- Detailed responses: description, examples for different status codes and field comments.\n- Endpoint Security Type\n- Includes Tesnet's base URL.\n\n## How to open Swagger UI\nThere's several options for the approach: \n\n- GitHub Pages:\n    - You only have to open: https://binance.github.io/binance-api-swagger/\n\n- Local UI instance:\n    1. Install [Docker](https://docs.docker.com/get-docker/)\n    2. Run locally:\n        ```bash\n        ./start.sh\n        ```\n    3. Open http://localhost:8080\n\n- Swagger Inspector:\n    1. Open YAML file in GitHub and click \"Raw\":\n        \u003cp align=\"left\"\u003e\u003cimg src=\"assets/1.png\" alt=\"Screenshot to indicate location of the raw button\" width=\"334\" height=\"73\"/\u003e\u003c/p\u003e\n    2. Copy and use previous step's URL in https://inspector.swagger.io/.\n\n- IDE (Integrated Development Environment):\n    - There's available plugins that can be used to preview Swagger UI.\n\n- Swagger Hub:\n    - https://app.swaggerhub.com/apis/binance_api/BinanceSpotAPI/1.0\n    - You can also explore the `Export` section to export as Client SDK, Server Stub or Documentation in multiple languages.\n\n## Swagger UI Preview\n\u003cp align=\"center\"\u003e\u003cimg src=\"assets/2.png\" alt=\"Swagger UI Preview\"/\u003e\u003c/p\u003e\n\n## Limitations\n- Futures and Vanilla Options APIs are not supported:\n    - `/fapi/*`\n    - `/dapi/*`\n    - `/vapi/*`\n\n- CORS restrictions: Using Swagger UI beyond as API Documentation consulting, i.e, by actually trying out requests can result in invalid responses for endpoints requiring API Key (requests with header `X-MBX-APIKEY`). Swagger Inspector doesn't have this limitation.\n\n- No integration of automated generation for dynamic parameters, such as `signature` and `timestamp`.\n    \n## Contributing\nContributions are welcome!\u003cbr\u003e\nIf you've found an issue within this project, please open an issue to discuss what you would like to change.\u003cbr\u003e\nIf it's an issue with the API, please open a topic at our [Binance API Community Forum](https://dev.binance.vision/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinance%2Fbinance-api-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbinance%2Fbinance-api-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinance%2Fbinance-api-swagger/lists"}