# Cubic API

> Read-only REST API for Cubic customers to query their own shipments: status, route and milestones, carrier and bill numbers, containers, packages and parcel tracking.

Base URL: `https://api.gocubic.io/v1`. Auth: `Authorization: Bearer $CUBIC_API_KEY`.
Every page below is plain markdown. The whole documentation in one file: https://developers.gocubic.io/llms-full.txt. Start with "For AI agents".

## Getting started

- [Overview](https://developers.gocubic.io/index.md): A read-only REST API for Cubic customers to query their own shipments.
- [Quickstart](https://developers.gocubic.io/quickstart.md): Get a key, verify it, and list shipments, in curl, TypeScript and Python.
- [For AI agents](https://developers.gocubic.io/for-ai-agents.md): For a coding agent building on the Cubic API — what to read, the order of operations, and the mistakes to avoid.

## Concepts

- [Authentication](https://developers.gocubic.io/authentication.md): Bearer API keys. One key belongs to one customer account.
- [Pagination](https://developers.gocubic.io/pagination.md): Cursor pagination on GET /v1/shipments. Follow nextCursor until it is null.
- [Errors](https://developers.gocubic.io/errors.md): RFC 9457 application/problem+json with a machine-readable code and a hint.
- [Rate limits](https://developers.gocubic.io/rate-limits.md): 60 requests per minute per key, RateLimit headers on every response, and Retry-After on 429.

## Shipments

- [The Shipment object](https://developers.gocubic.io/shipment-object.md): Every field of the Shipment object, its enums, and the rules for nulls, dates and units.
- [Shipment types](https://developers.gocubic.io/shipment-types.md): What each service type looks like, with one complete example per family.
- [Recipes](https://developers.gocubic.io/recipes.md): A small client with pagination and 429 backoff, and runnable snippets for common jobs.

## Project

- [Changelog](https://developers.gocubic.io/changelog.md): Changes to the Cubic API.

## API description

- [OpenAPI 3.1 document](https://developers.gocubic.io/openapi.json): Every endpoint, parameter, schema, enum value, error and example, machine-readable.
- [Complete documentation in one file](https://developers.gocubic.io/llms-full.txt): All pages above concatenated as markdown.
- [Rendered API reference](https://developers.gocubic.io/reference): The OpenAPI document as an HTML page, for humans.