Datasets API endpoint
Returns value counts for the Instagram users dataset by the required `facet`: `is_verified`, `is_business_account`, `has_bio`, `has_external_url`, `category_name` or `source_tier`. The counts follow the search filters, including follower ranges and creation dates, and cover up to 50 values.
/datasets/instagram-users/facetsReturns terms aggregation counts for the Instagram users dataset under search filters.
Dataset id enum:
instagram-usersQuery parameters:
facet: required facet field enum: is_verified, is_business_account, has_bio, has_external_url, category_name, source_tier.q: optional full-text query over username, full_name, and biography, max 256 characters.username: optional exact username filter (case-insensitive), max 128 characters.category_name: optional exact category filter (case-insensitive, e.g. Digital Creator), max 128 characters.source_tier: optional exact filter for seed tier (e.g. crossref, vertical-hashtags, mention-graph, head-directory).is_verified: optional filter for Instagram verification checkmark.is_business_account: optional filter for business or creator accounts.has_bio: optional filter for a non-empty profile biography.has_external_url: optional filter for a linked external URL.min_followers: optional minimum follower count.max_followers: optional maximum follower count.min_ratio: optional minimum follower-to-following ratio.max_ratio: optional maximum follower-to-following ratio.sort: optional sort enum: relevance, followers_desc, followers_asc, crawled_at_desc, crawled_at_asc, created_at_desc, created_at_asc.Response behavior:
facet parameter must be one of the documented enum values; invalid values return 400.50 buckets.| Field | Filled in, of 50 checked | Values in the sample |
|---|---|---|
| value | 50 | |
| count | 50 | 241 to 17,751, median 664 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| facet | string | Yes | Facet enum: is_verified, is_business_account, has_bio, has_external_url, category_name, source_tier Allowed values: is_verified, is_business_account, has_bio, has_external_url, category_name, source_tier. | is_verified | |
| q | string | No | Full-text query over username, full_name and biography, max 256 characters | ||
| username | string | No | Exact username filter (case-insensitive), max 128 characters | ||
| category_name | string | No | Exact category filter (case-insensitive, e.g. Digital Creator), max 128 characters | ||
| source_tier | string | No | Exact filter for seed tier (e.g. crossref, vertical-hashtags, mention-graph, head-directory) | ||
| is_verified | boolean | No | Filter by the Instagram verification checkmark | ||
| is_business_account | boolean | No | Filter by business or creator accounts | ||
| has_bio | boolean | No | Filter by a non-empty profile biography | ||
| has_external_url | boolean | No | Filter by a linked external URL | ||
| min_followers | integer | No | Minimum follower count | ||
| max_followers | integer | No | Maximum follower count | ||
| min_ratio | number | No | Minimum follower-to-following ratio | ||
| max_ratio | number | No | Maximum follower-to-following ratio | ||
| created_after | string | No | Accounts created on or after this date (RFC3339 or YYYY-MM-DD) | ||
| created_before | string | No | Accounts created on or before this date (RFC3339 or YYYY-MM-DD) | ||
| crawled_after | string | No | Records last refreshed on or after this date (RFC3339 or YYYY-MM-DD) | ||
| crawled_before | string | No | Records last refreshed on or before this date (RFC3339 or YYYY-MM-DD) | ||
| sort | string | No | Sort enum: relevance, followers_desc, followers_asc, crawled_at_desc, crawled_at_asc, created_at_desc, created_at_asc Allowed values: relevance, followers_desc, followers_asc, crawled_at_desc, crawled_at_asc, created_at_desc, created_at_asc. | ||
| page | integer | No | 1 | Page number, defaults to 1 | |
| page_size | integer | No | 20 and maxes at 100 | Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/instagram-users/facets?facet=is_verified&q=coffee&is_verified=true&is_business_account=true&has_bio=true&has_external_url=true&sort=relevance&page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"dataset": "instagram-users",
"facet": "category_name",
"items": [
{
"value": "Digital Creator",
"count": 450000
},
{
"value": "Artist",
"count": 280000
},
{
"value": "Entrepreneur",
"count": 195000
}
]
}
}Request schema
No body schema
Response schema
#/definitions/datasets.instagramUsersFacetResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | datasets.InstagramUserFacetResponse | No | ||||
| data.dataset | string | No | Identifier of the dataset queried (`instagram-users`). | |||
| data.facet | string | No | Facet that was aggregated. | |||
| data.items | array | No | Facet values with the number of matching records for each. | |||
| data.items[].count | integer | No | Number of users with this value. | |||
| data.items[].value | string | No | Facet value being counted. | |||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/datasets/instagram-users/facets?facet=is_verified&q=coffee&is_verified=true&is_business_account=true&has_bio=true&has_external_url=true&sort=relevance&page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"