- Auth: API key (Authentication)
- Scope: none
- Cost: Free.
Read it once and cache it: it changes rarely.
The values industry and region accept. Industries are the Store Leads category taxonomy at two
levels (26 categories, 182 subcategories); each store's industry is our own reading of its
homepage. Regions group the countries stores sell from. Free; any key.
Request
curl "https://api.installgraph.com/v1/industries" \
-H "Authorization: Bearer $INSTALLGRAPH_API_KEY"
Response
200. The example's stores are fictional.
{
"data": {
"industries": [
{
"name": "Apparel",
"path": "/Apparel",
"subcategories": [
{
"name": "Footwear",
"path": "/Apparel/Footwear"
}
]
}
],
"regions": [
{
"id": "north-america",
"name": "North America",
"countries": [
"US",
"CA"
]
}
],
"aovBands": [
{
"id": "100-200",
"label": "$100–200"
}
]
},
"meta": {
"requestId": "6f1c2a9e-4b7d-4e2a-9c51-0d3b8e7f2a14",
"creditsUsed": 0,
"creditsCharged": 0,
"creditsRemaining": 46,
"freeRepulls": 0
}
}
Fields
| Field | Type | Description |
|---|---|---|
data.industries |
object[] | |
data.industries[].name |
string | Example: Apparel. |
data.industries[].path |
string | Example: /Apparel. |
data.industries[].subcategories |
object[] | |
data.industries[].subcategories[].name |
string | Example: Footwear. |
data.industries[].subcategories[].path |
string | Example: /Apparel/Footwear. |
data.regions |
object[] | |
data.regions[].id |
Region | One of north-america, latin-america, europe, middle-east-africa, asia-pacific. |
data.regions[].name |
string | Example: North America. |
data.regions[].countries |
string[] | |
data.aovBands |
object[] | |
data.aovBands[].id |
string | Example: 100-200. |
data.aovBands[].label |
string | Example: $100–200. |
Every keyed response also carries meta (requestId, creditsUsed, creditsRemaining, freeRepulls) and the X-Credits-* and X-RateLimit-* headers. See Credits and Rate limits.
Errors
| Status | Code | Meaning | What to do |
|---|---|---|---|
| 401 | missing_api_key |
No key was sent. | Send Authorization: Bearer sfs_… or X-API-Key: sfs_…. |
| 401 | invalid_api_key |
The key is not one we issued. | Check for truncation or whitespace; keys are sfs_ plus 32 letters and digits. |
| 401 | api_key_revoked |
The key was revoked. | Make a new key at installgraph.com/account. |
All codes: Errors.