---
title: "Get the service index: every operation, the documentation, the limits, the conventions."
method: GET
path: "/api/v1"
tags: ["Service"]
---

# Get the service index: every operation, the documentation, the limits, the conventions.

`GET /api/v1`

## Request

- Base URL: `https://www.veridionmarkets.com`
- URL: `https://www.veridionmarkets.com/api/v1`
- Auth: one of:
  - none
  - HTTP bearer

The first URL a client handed a base path calls. Derived at build time from this document, the problem catalog and the contract limits, so it cannot disagree with them. Static for a deployment; revalidates hourly.

## Response `200`

The service index.

- ServiceIndex
  - `service` string, required: The API's title, from the OpenAPI document's info.title.
  - `version` '1.21.0', required: The contract version this response was produced under; the same value as X-API-Version.
  - `description` string, nullable, required: info.summary from the OpenAPI document, or null when it has none.
  - `documentation` object, required
    - `openapi` string, required: Absolute URL of the machine-readable contract.
    - `reference` string, required: Absolute URL of the rendered API reference.
    - `problems` string, required: Absolute URL of the problem-type catalog every error code resolves under.
    - `changelog` string, required: Absolute URL of the versioned changelog.
    - `overview` string, required: Absolute URL of the product overview and access request page.
  - `operations` object[], required: Every operation in the OpenAPI document, sorted by path then method.
    - `operation_id` string, required: The OpenAPI operationId, or method:path when the operation has none.
    - `method` string, required: HTTP method, upper case. Every operation is a read.
    - `path` string, required: The templated path exactly as it appears in the OpenAPI document.
    - `href` string, required: The path resolved against the document's first server URL.
    - `summary` string, required: The operation summary, or an empty string.
    - `tag` string, required: The operation's first tag, or Untagged.
    - `authentication` 'none' | 'optional_bearer_key' | 'bearer_key_required', required: Derived from the operation's security requirements: none when no scheme applies, optional_bearer_key when an anonymous requirement sits beside a keyed one, bearer_key_required when only keyed requirements apply.
  - `authentication` object, required
    - `scheme` 'bearer', required
    - `header` string, required: The literal header shape a keyed request sends.
    - `free_tier` object, required: The anonymous tier's limits, from the contract constants.
      - `key_required` false, required
      - `max_rows_per_request` 25, required
      - `requests_per_window` 60, required
      - `window_seconds` 3600, required
    - `licensed` object, required
      - `max_rows_per_request` 1000, required
      - `request_access` string, required: Where a licensed key is requested.
  - `conventions` object, required: One sentence per convention a client must know before the first call.
    - `pagination` string, required
    - `point_in_time` string, required
    - `incremental` string, required
    - `errors` string, required
    - `unknown_parameters` string, required
    - `methods` string, required
    - `methodology_version` 'receipt-or-drop-v1', required
  - `counts` object, required
    - `operations` integer, required: Length of operations, including this one.
    - `problem_codes` integer, required: Number of problem codes in the catalog.
  - `generated_at` string, date-time, required: When this response was rendered. The index is static for the deployment and revalidates hourly.

## Other responses

- `400`: This endpoint accepts no query parameters.
- `401`: The supplied bearer key is invalid.
- `403`: The supplied key is not scoped for the contract documents.

---

[API](https://skmtc.dev/veridionmarkets/apis/veridion-disclosure-api.md) · [All operations](https://skmtc.dev/veridionmarkets/apis/veridion-disclosure-api/llms.txt) · [OpenAPI document](https://skmtc.dev/veridionmarkets/apis/veridion-disclosure-api/revisions/af69a5d7354e?raw)