https://github.com/orca-scan/orca-scan-openapi
Orca Scan OpenAPI Specification
https://github.com/orca-scan/orca-scan-openapi
openapi
Last synced: 5 months ago
JSON representation
Orca Scan OpenAPI Specification
- Host: GitHub
- URL: https://github.com/orca-scan/orca-scan-openapi
- Owner: orca-scan
- License: mit
- Created: 2025-09-01T15:30:13.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-09-03T12:52:17.000Z (7 months ago)
- Last Synced: 2025-10-02T04:51:39.035Z (6 months ago)
- Topics: openapi
- Homepage: https://orcascan.com/guides/rest-api-f09a21c3
- Size: 13.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Orca Scan OpenAPI
This repository contains [OpenAPI specifications](https://www.openapis.org/) for the Orca Scan REST API.
Files can be found in the [openapi/](openapi/) directory (e.g. [spec3.yaml](openapi/spec3.yaml)).
### Why?
An OpenAPI specification makes it easier to integrate with Orca Scan's API.
### API docs
See the official guide: [Orca Scan REST API](https://orcascan.com/guides/rest-api-f09a21c3)
### Authentication
The API uses bearer token authentication.
```bash
curl -sS -H "Authorization: Bearer API_KEY" \
https://api.orcascan.com/v1/sheets
```
### Status codes
- Global list captured in the vendor extension `x-orca-status-codes` for documentation tooling.
---
## License
[MIT License](LICENSE) © Orca Scan - a [barcode app](https://orcascan.com) with simple [barcode tracking APIs](https://orcascan.com/guides?tag=for-developers).