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

# API Reference

> The base URL, authentication, and conventions shared by every Orbbit Data API endpoint.

Every endpoint below is listed with its parameters, example responses, and a **Try it** button that sends a real request from your browser. For what each data set means and why it's useful, see the **Documentation** tab.

## Base URL

All requests go to:

```text theme={null}
https://api.orbbit.co
```

## Authentication

Send your API key in the `Authorization` header on every request:

```bash theme={null}
--header 'authorization: Bearer YOUR_API_KEY'
```

Each endpoint needs its own scope on the key. See [Authentication](/authentication) for how to create a key and choose its scopes.

## Versions

The version is part of the path. Every endpoint starts with `/v1`.

## Requests and responses

* Every endpoint is a `GET` and only reads data.
* Responses are JSON with `snake_case` field names. A single record comes back as `{ "data": { ... } }`, a list as `{ "data": [ ... ] }`.
* Lists that can be long return one page at a time with a `next_cursor`. Pass it back as `cursor` to get the next page; `null` means you have them all.
* Every error has the same shape, `{ "error": { "type", "message" } }`. See [Errors](/errors).

## Endpoints

| Section             | Endpoint                                                                           | Scope                   |
| ------------------- | ---------------------------------------------------------------------------------- | ----------------------- |
| Commodities         | [`GET /v1/commodities`](/api-reference/commodities/search-commodity-series)        | `search-commodities`    |
| Commodities         | [`GET /v1/commodities/prices`](/api-reference/commodities/get-commodity-prices)    | `get-commodity-prices`  |
| CPG › Branded Food  | [`GET /v1/branded-foods`](/api-reference/branded-food/search-branded-foods)        | `search-branded-foods`  |
| CPG › Branded Food  | [`GET /v1/branded-foods/categories`](/api-reference/branded-food/list-categories)  | `search-branded-foods`  |
| CPG › Branded Food  | [`GET /v1/branded-foods/{id}`](/api-reference/branded-food/get-a-branded-food)     | `get-branded-foods`     |
| CPG › D2C › Shopify | [`GET /v1/stores`](/api-reference/shopify/search-stores)                           | `search-stores`         |
| CPG › D2C › Shopify | [`GET /v1/stores/{id}`](/api-reference/shopify/get-a-store)                        | `get-store`             |
| CPG › D2C › Shopify | [`GET /v1/stores/{id}/products`](/api-reference/shopify/list-store-products)       | `get-store-products`    |
| CPG › D2C › Shopify | [`GET /v1/stores/{id}/collections`](/api-reference/shopify/list-store-collections) | `get-store-collections` |
| CPG › D2C › Shopify | [`GET /v1/products/{id}`](/api-reference/shopify/get-a-product)                    | `get-product`           |