# OpenAPI spec

> Machine-readable specification of the full API.

Source: https://tickos.dev/docs/openapi

The complete API is described by an OpenAPI 3.1 specification, served publicly (no authentication) at:

```bash
https://api.tickos.dev/v1/openapi.json
```

## What you can do with it

- Import it into Postman, Insomnia or Bruno to get a ready-to-use collection.
- Render it with Swagger UI or Scalar for a browsable reference.
- Generate typed clients with openapi-generator or openapi-typescript.

Generate TypeScript types:

```bash
npx openapi-typescript https://api.tickos.dev/v1/openapi.json \
  -o tickos-api.d.ts
```

> **Tip:** The Playground is generated from this spec, so every operation it lists can be tried there with a Send button. These guides are written separately and add context the spec does not cover (behaviors, limits and examples).