API Reference

Everything you need to integrate VeinData into your ecommerce tools.

Base URL

https://vein.auto7lab.com

Authentication

All API requests require an API key passed via the x-api-key header.

curl -H "x-api-key: vn_live_your_key_here" \
  https://vein.auto7lab.com/v1/shopify/store/allbirds.com

API key prefixes:

vn_live_* — Production keys (metered usage)
vn_test_* — Test keys (no billing)

Rate Limits

Plan	Requests/month	Rate limit
Free	100	1 req/sec
Pro	10,000	50 req/sec

Error Codes

Code	Meaning	Example
401	Missing or invalid API key	{"error":"missing x-api-key header"}
400	Bad request (e.g. missing domain)	{"error":"domain is required"}
429	Rate limit exceeded	{"error":"rate limit exceeded"}
502	Upstream error (store unreachable)	{"error":"failed to fetch store"}

Endpoints

GET/v1/shopify/store/{domain}

Get the profile and metadata for a Shopify store.

Path Parameters

domainShopify store domain (e.g. allbirds.com)

Example

curl -H "x-api-key: vn_live_xxx" \
  https://vein.auto7lab.com/v1/shopify/store/allbirds.com

Response

{
  "domain": "allbirds.com",
  "name": "Allbirds",
  "description": "Allbirds sustainable shoes & clothing...",
  "currency": "USD",
  "country": "US",
  "url": "https://allbirds.com",
  "fetched_at": "2025-04-14T12:00:00Z"
}

GET/v1/shopify/store/{domain}/products

Get the product catalog of a Shopify store. Returns paginated results by default, or all products with ?all=true.

Path Parameters

domainShopify store domain (e.g. allbirds.com)

Query Parameters

pagePage number (default: 1)

limitProducts per page (default: 30, max: 250)

allSet to "true" to fetch all products (cached 6h)

Example

# Paginated
curl -H "x-api-key: vn_live_xxx" \
  "https://vein.auto7lab.com/v1/shopify/store/allbirds.com/products?page=1&limit=10"

# All products
curl -H "x-api-key: vn_live_xxx" \
  "https://vein.auto7lab.com/v1/shopify/store/allbirds.com/products?all=true"

Response

{
  "domain": "allbirds.com",
  "count": 42,
  "products": [
    {
      "id": 6543217890,
      "title": "Men's Tree Runners",
      "handle": "mens-tree-runners",
      "vendor": "Allbirds",
      "product_type": "Shoes",
      "tags": ["men", "running", "sustainable"],
      "variants": [
        {
          "id": 39876543210,
          "title": "10 / Kauri Marine",
          "price": "98.00",
          "compare_at_price": null,
          "sku": "TR-M-10-KM",
          "available": true
        }
      ],
      "images": [
        {
          "id": 28765432190,
          "src": "https://cdn.shopify.com/...",
          "position": 1
        }
      ],
      "created_at": "2024-01-15T10:30:00-05:00",
      "updated_at": "2025-04-10T08:15:00-05:00"
    }
  ],
  "cached": false
}

GET/v1/shopify/store/{domain}/changes

Detect product catalog changes since the last snapshot. On first call, creates a baseline snapshot and returns a message. On subsequent calls, returns added products, removed products, and price changes.

Path Parameters

domainShopify store domain (e.g. allbirds.com)

Example

curl -H "x-api-key: vn_live_xxx" \
  https://vein.auto7lab.com/v1/shopify/store/allbirds.com/changes

Response

{
  "domain": "allbirds.com",
  "previous_snapshot_at": "2025-04-13T12:00:00Z",
  "current_snapshot_at": "2025-04-14T12:00:00Z",
  "new_products": [
    {
      "id": 6543219999,
      "title": "Women's SuperLight Tree Gliders",
      "handle": "womens-superlight-tree-gliders",
      ...
    }
  ],
  "removed_products": [],
  "price_changes": [
    {
      "product_id": 6543217890,
      "product_title": "Men's Tree Runners",
      "variant_id": 39876543210,
      "variant_title": "10 / Kauri Marine",
      "old_price": "98.00",
      "new_price": "108.00"
    }
  ],
  "summary": {
    "new_count": 1,
    "removed_count": 0,
    "price_change_count": 1
  }
}

Ready to start?

Get 100 free API requests per month. No credit card required.

Get your API key