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

# Auth test

> Validates API key and returns plan info, limits, and feature access



## OpenAPI

````yaml /openapi/v1.yaml get /v1/ping
openapi: 3.1.0
info:
  title: Vintl API
  version: 1.0.0
  description: >
    Point-in-time macro-economic and treasury data API.


    The killer feature: `?as_of=DATE` returns what economic data was known at
    any historical date.

    Requires Pro plan or higher — free plan returns latest data only.
  contact:
    name: Vintl Support
    url: https://vintl.io
  license:
    name: Proprietary
servers:
  - url: https://api.vintl.io
    description: Production
  - url: http://localhost:8080
    description: Local development
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: Liveness and readiness probes
  - name: Auth
    description: API key validation and plan info
  - name: Treasury
    description: U.S. Treasury yield curve data (1990-present, never revised)
  - name: Macro
    description: Economic indicators with point-in-time vintage tracking
  - name: Series
    description: Series discovery and metadata
  - name: Insider
    description: SEC Form 4 insider trading data with cluster detection
paths:
  /v1/ping:
    get:
      tags:
        - Auth
      summary: Auth test
      description: Validates API key and returns plan info, limits, and feature access
      responses:
        '200':
          description: API key is valid
          content:
            application/json:
              example:
                object: ping
                request_id: req_19d40c11691b60ece4cc73351271260
                status: ok
                results:
                  - status: ok
                    message: API key is valid
                    plan: pro
                    monthly_limit: 50000
                    rate_per_minute: 60
                    vintage_access: true
                results_count: 1
                has_more: false
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://macrodata.dev/errors/unauthorized
            title: Unauthorized
            status: 401
            detail: API key is required. Set the X-API-Key header.
            instance: /v1/ping
  schemas:
    Problem:
      type: object
      description: RFC 9457 Problem Details (Content-Type application/problem+json)
      properties:
        type:
          type: string
          format: uri
          example: https://macrodata.dev/errors/not-found
        title:
          type: string
          example: Not Found
        status:
          type: integer
          example: 404
        detail:
          type: string
          example: series 'INVALID' not found
        instance:
          type: string
          example: /v1/series/INVALID
        request_id:
          type: string
          example: req_19d40c11691b60ece4cc73351271260
        field:
          type: string
          description: Which field caused the error (on validation errors)
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key prefixed with `mda_live_sk_`

````