Installgraph API

Quickstart

You need a work email address. A browser is enough; a terminal is optional. This takes about two minutes.

1. Get a key

Start free with your email and open the sign-in link we send. Your key is step 1 on your dashboard; copy it then, as it is shown once. With a company email you start with 25 free credits, and 25 more once the link is clicked (once per company domain). Keep the key in an environment variable:

export INSTALLGRAPH_API_KEY="sfs_…"

2. Count before you pay

Counts are free. How many UK stores run Klaviyo?

curl "https://api.installgraph.com/v1/apps/klaviyo/companies/count?country=GB" \
  -H "Authorization: Bearer $INSTALLGRAPH_API_KEY"

{ "data": { "app": "klaviyo", "count": 1284 }, "meta": { "creditsUsed": 0, "creditsRemaining": 50 } }

3. Pull the rows you need

Each store in the page costs 1 credit. limit caps the spend.

curl "https://api.installgraph.com/v1/apps/klaviyo/companies?country=GB&limit=10" \
  -H "Authorization: Bearer $INSTALLGRAPH_API_KEY"

The same call in JavaScript (Node 18+) and Python:

const res = await fetch("https://api.installgraph.com/v1/apps/klaviyo/companies?country=GB&limit=10", {
  headers: { Authorization: `Bearer ${process.env.INSTALLGRAPH_API_KEY}` },
});
const { data, pagination, meta } = await res.json();
console.log(data.map((s) => s.domain), meta.creditsRemaining);

import os, requests

res = requests.get(
    "https://api.installgraph.com/v1/apps/klaviyo/companies",
    params={"country": "GB", "limit": 10},
    headers={"Authorization": f"Bearer {os.environ['INSTALLGRAPH_API_KEY']}"},
)
body = res.json()
print([s["domain"] for s in body["data"]], body["meta"]["creditsRemaining"])

No code: a CSV in your browser

Add .csv to any endpoint and your key as ?key=, and open the URL. The browser downloads a spreadsheet, charged the same as the JSON:

https://api.installgraph.com/v1/apps/klaviyo/companies.csv?country=GB&limit=10&key=sfs_…

Nested fields become columns (industry.category), and lists are joined with "; ". limit (up to 500) still caps the spend; the next page's cursor is in the X-Next-Cursor response header.

To look up one store instead: GET /v1/companies/{domain}.

Conventions

• Base URL: https://api.installgraph.com. Every path starts with /v1. HTTPS only.
• Auth: Authorization: Bearer sfs_… (or X-API-Key) from code, or ?key=sfs_… on a URL in a browser. See Authentication.
• CSV: add .csv to any endpoint's path for a spreadsheet instead of JSON.
• Responses: JSON. A success is { "data", "meta" }; lists add "pagination". An error is { "error": { "code", "message", "requestId" } }. See Errors.
• Times are ISO 8601 in UTC (2026-11-02T03:40:12.000Z). Countries are ISO 3166-1 alpha-2 (GB).
• Missing values are null, never omitted: every documented field is always present.
• Freshness: each store's homepage is scanned once a week. See Data model.
• Stability: within v1, fields and error codes are added but never renamed or removed. Ignore fields you do not recognise.

Endpoints

Guides

• Authentication: getting a key, sending it, scopes.
• Credits and billing: what costs what, free re-pulls, running out.
• Pagination: cursors and a loop that reads a whole list.
• Rate limits: 60 requests a minute, headers, retrying.
• Errors: every code, and what to do about it.
• Data model: how detection works, store status, industries, regions.
• Using the API from an AI agent: machine-readable docs and a safe spending loop.

Machine-readable

• OpenAPI 3.1 spec: every public endpoint, schema and example.
• llms.txt and llms-full.txt: an index, and every docs page in one Markdown file.
• Every docs page as Markdown: add .md to its URL, for example /docs/authentication.md.

Support

Quote the requestId from the response (also in the X-Request-Id header). For more than $1,000 or 40,000 stores in 30 days, the full dataset, or a weekly changes feed: Talk to us.