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

# Quickstart

> Make your first StoreInspect API requests.

## Before you begin

* A paid StoreInspect plan with API access
* A server-side API key
* A server environment that can store secrets safely

<Warning>
  Do not call StoreInspect API routes from browser code. API keys should stay on your server.
</Warning>

## 1. Check usage

Start with `GET /usage` to confirm the key is valid and see the account's current quota and credit state.

```bash theme={null}
curl https://storeinspect.com/api/v1/usage \
  -H "Authorization: Bearer $STOREINSPECT_API_KEY"
```

## 2. Discover filter values

Use `GET /taxonomy` to discover supported filter values for countries, categories, apps, themes, pixels, technologies, contact roles, seniority, and social platforms.

```bash theme={null}
curl https://storeinspect.com/api/v1/taxonomy \
  -H "Authorization: Bearer $STOREINSPECT_API_KEY"
```

## 3. Search Shopify stores

Run a focused store search with at least one positive narrowing filter.

```bash theme={null}
curl https://storeinspect.com/api/v1/stores/search \
  -H "Authorization: Bearer $STOREINSPECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": {
      "countries": ["US"],
      "contacts": {
        "has_revealable_contacts": true
      }
    },
    "limit": 25
  }'
```

## 4. Follow cursors

Search endpoints return an opaque `next_cursor` when more data is available.

```json theme={null}
{
  "object": "list",
  "data": [],
  "next_cursor": "cur_Q29x7nK8uP4sVb2mL9rTe6Yh3DcWzAaF5gJ1kNpX0qRu",
  "request_id": "req_abc123"
}
```

Pass that cursor with the same filters to fetch the next page. Do not parse or construct cursor values.

## 5. Reveal selected contacts

Reveal only the contact IDs you plan to use. Reveals spend shared StoreInspect contact credits.

```bash theme={null}
curl https://storeinspect.com/api/v1/contacts/reveal \
  -H "Authorization: Bearer $STOREINSPECT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: reveal-batch-001" \
  -d '{
    "contact_ids": [
      "ct_Kx2Pq9Q7rVh3_4nQm8sTzY6pLwE"
    ]
  }'
```