Skip to main content
This endpoint returns a compliant OpenAPI 3.0.1 specification document for the Vantage API. You can use this specification to:
  • Generate client libraries for your preferred programming language
  • Explore the API using tools like Swagger UI or Postman
  • Understand the complete API schema, including all endpoints, request/response models, and authentication requirements
The OpenAPI specification is always up-to-date and reflects the current state of the Vantage API.
The “Try it” feature is not available for this endpoint. Please use the code examples below or make requests directly to the endpoint URL.
curl --request GET \
     --url https://api.vantage.sh/v2/oas_v3.json \
     --header 'authorization: Bearer TOKEN'

​
Authentication

This endpoint requires authentication via a Bearer token in the Authorization header. See Authentication for details on creating an API access token.

​
Request Parameters

This endpoint does not accept any query parameters or path parameters.

​
Response

The response is a JSON object containing the full OpenAPI specification, including:
  • API metadata (title, description, version, contact information)
  • Server information
  • Authentication schemes
  • All available endpoints with their methods, paths, parameters, and request/response schemas
  • Data models and schema definitions
{
  "openapi": "3.0.1",
  "info": {
    "title": "Vantage",
    "description": "Vantage API",
    "termsOfService": "https://www.vantage.sh/terms-of-use",
    "contact": {
      "name": "Vantage Support",
      "url": "https://www.vantage.sh",
      "email": "[email protected]"
    }
  },
  ...
}
The full specification document is extensive and includes detailed information about all endpoints, request/response models, and authentication methods available in the Vantage API.