> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Get OpenAPI specification

> Retrieve the OpenAPI 3.0.1 specification for Vantage's API.

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](https://swagger.io/tools/swagger-ui/) or [Postman](https://www.postman.com/)
* Understand the complete API schema, including all endpoints, request/response models, and authentication requirements

<Info>
  The OpenAPI specification is always up-to-date and reflects the current state of the Vantage API.
</Info>

<Note>
  The "Try it" feature is not available for this endpoint. Please use the code examples below or make requests directly to the endpoint URL.
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
       --url https://api.vantage.sh/v2/oas_v3.json \
       --header 'authorization: Bearer TOKEN'
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.vantage.sh/v2/oas_v3.json"
  headers = {
      "authorization": "Bearer TOKEN"
  }

  response = requests.get(url, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.vantage.sh/v2/oas_v3.json', {
    method: 'GET',
    headers: {
      'authorization': 'Bearer TOKEN'
    }
  });

  const data = await response.json();
  console.log(data);
  ```
</RequestExample>

## Authentication

This endpoint requires authentication via a Bearer token in the Authorization header. See [Authentication](/api/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

<ResponseExample>
  ```json theme={null}
  {
    "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": "support@vantage.sh"
      }
    },
    ...
  }
  ```
</ResponseExample>

<Note>
  The full specification document is extensive and includes detailed information about all endpoints, request/response models, and authentication methods available in the Vantage API.
</Note>