Welcome to the OS Hub API developer resources. This repository contains everything you need to integrate with the OS Hub API, including comprehensive documentation, examples, and testing tools.
- Get your API key → Subscribe for access. You will receive instructions to obtain your token within 2 business days
- Make your first call → See our Quick Start Guide
- Test with Postman → Import our collection (WIP)
| Resource | Description |
|---|---|
| Quick Start Guide | Getting connected, API token and description of most common endpoints |
| Postman Tutorial | Step-by-step guide for connecting to the API using Postman |
| Legacy API Endpoints | Complete endpoint reference |
| NEW (Beta) API Endpoints | Complete endpoint reference |
| How to Guides | Recommended workflows for most common use cases |
| Terms of Service | API subscription T&Cs |
- Postman Collection - Import and test all endpoints
The OS Hub API enables you to:
- Search production locations by OS ID, company name, sector, or other criteria
- Allocate a unique identifier (OS ID) for each production site
- Identify incorrect names and addresses in your supplier records
- Integrate facility information into your applications (e.g. sector, product type, processing type, etc.)
- Build compliance tools for due diligence requirements
Have questions or want to learn more?
- Report bugs, request features, ask technical questions, etc. → Contact Support
- Want to sign up for a subscription? → Talk to our Sales Team
- Apply for free API access → Registered non-profits automatically get 50% off all Open Supply Hub Premium features. You can also apply for free or further discounted access. Learn more in our Free/Discounted Access to Premium Features Policy.
This documentation is available under the MIT License.
Need help? Check our Getting Started Guide or contact support.