---
title: "API index"
method: GET
path: "/v1"
tags: ["Meta"]
---

# API index

`GET /v1`

## Request

- Base URL: `https://api.parkypass.com`
- URL: `https://api.parkypass.com/v1`
- Auth: none required

Links to documentation, this OpenAPI document, the stream URL, every endpoint with a one-line description, limits and the attribution rule. Needs no key and is not rate limited.

## Response `200`

Index.

- Index
  - `schema_version` 1, required: Response format version. Fields are only added within a version.
  - `name` string, required
  - `description` string
  - `docs` object, required
    - `html` string, uri
    - `markdown` string, uri
  - `openapi_url` string, uri, required
  - `stream_url` string, uri, required
  - `sse_url_template` string
  - `authentication` string
  - `rate_limits` object
  - `attribution_rule` string, required
  - `park_parameter` string
  - `endpoints` object[], required
    - `path` string, required
    - `description` string, required
  - `docs_url` string, uri, required: Developer documentation.
  - `attribution` Attribution, required: Required credit. Wherever Parky data is shown, display `text` with a visible link to `url`; the link must stay visible.
    - `text` 'Live data from parkypass.com', required: Text to display.
    - `url` string, uri, required: The matching parkypass.com page to link.
    - `required` true, required: Always true: attribution is a condition of use.
  - `generated_at` string, date-time, required: When Parky built this response.

---

[API](https://skmtc.dev/parkypass/apis/parky-api.md) · [All operations](https://skmtc.dev/parkypass/apis/parky-api/llms.txt) · [OpenAPI document](https://skmtc.dev/parkypass/apis/parky-api/revisions/c3abcb8be74f?raw)