Shared Data API — OpenAPI / Swagger
The ImmPort Shared Data API is fully documented using OpenAPI 3.0 and available in two formats:
Interactive Swagger UI
Explore and test all Shared Data API endpoints directly from your browser:
Swagger UI
Use the Swagger UI to:
- Browse all available endpoints and their parameters
- Try live requests against the API
- View example request/response payloads
To authenticate in Swagger UI:
- Click the "Authorize" button at the top of the page
- Enter your API key in the Bearer token field
- Click Authorize — authenticated endpoints will now be accessible
Machine-Readable OpenAPI Specification
The full OpenAPI 3.0 specification is available in JSON format for use with code generators, API clients, and automated tooling:
https://www.dev.immport.org/data/query/v3/api-docs
This endpoint is useful for:
- Generating client SDKs (e.g. with OpenAPI Generator)
- Importing into API clients such as Postman or Insomnia
- Automated validation and contract testing
Authentication
All authenticated endpoints require an ImmPort API key passed as a Bearer token:
Authorization: Bearer <API_KEY>
For instructions on obtaining an API key, see the API Keys documentation.