{ "openapi": "3.0.1", "info": { "title": "Influencer Search and Audience Analytics API - HypeAuditor", "description": "Find Instagram, YouTube, TikTok, Twitch and X influencers with real filters (niche, followers, engagement, audience quality, audience country, age, gender) and pull audience reports: fake follower share, demographics, geography, contact emails. Read only. Bring your own HypeAuditor API key.", "version": "0.1", "x-build-id": "ot6wJ8SIiCbiehPxD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~influencer-search-audience-analytics-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-influencer-search-audience-analytics-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~influencer-search-audience-analytics-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-influencer-search-audience-analytics-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~influencer-search-audience-analytics-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-influencer-search-audience-analytics-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "service": { "title": "What to read", "enum": [ "discovery", "report", "suggester", "twitchGames", "planInfo" ], "type": "string", "description": "Discovery search finds creators on one network with the filters below and needs no identifiers, so it is the default. Influencer audience report reads the full audience analytics of each account in the identifiers input: audience quality score, fake follower share, gender, age, country and language of the audience, engagement rate and contact emails. Account suggester finds accounts by name. Twitch game ids looks up the ids the Twitch game filter takes. Credits left reads the report credits and discovery requests left on your plan.", "default": "discovery" }, "socialNetwork": { "title": "Social network", "enum": [ "instagram", "youtube", "tiktok", "twitch", "twitter" ], "type": "string", "description": "The network to search, or the network the report identifiers belong to.", "default": "instagram" }, "identifiers": { "title": "Identifiers", "type": "array", "description": "One per line. Influencer audience report: usernames (with or without @), profile URLs, YouTube channel ids or @handles, or numeric user ids when looking up by user id. Account suggester: names or usernames to search. Twitch game ids: game names. Discovery search and credits left read none.", "items": { "type": "string" } }, "nicheSearch": { "title": "Niche", "type": "string", "description": "Discovery, Instagram, YouTube and TikTok: a word or phrase describing the niche, such as home decor or vegan recipes. Cannot be combined with the keyword searches." }, "searchKeywords": { "title": "Keywords anywhere", "type": "array", "description": "Discovery: keywords to match anywhere in the creator's profile and content.", "items": { "type": "string" } }, "contentKeywords": { "title": "Keywords in content", "type": "array", "description": "Discovery: keywords to match in the creator's posts or videos.", "items": { "type": "string" } }, "bioKeywords": { "title": "Keywords in bio", "type": "array", "description": "Discovery: keywords to match in the creator's bio or channel description.", "items": { "type": "string" } }, "categoryIds": { "title": "Category ids", "type": "array", "description": "Discovery, Instagram and TikTok categories or YouTube thematics to include, as numbers from the provider's taxonomy, such as 1018.", "items": { "type": "string" } }, "excludeCategoryIds": { "title": "Excluded category ids", "type": "array", "description": "Discovery: category or thematic ids to leave out.", "items": { "type": "string" } }, "creatorCountries": { "title": "Creator countries", "type": "array", "description": "Discovery: two-letter codes of the countries the creator is in, such as us or gb.", "items": { "type": "string" } }, "creatorLanguages": { "title": "Creator languages", "type": "array", "description": "Discovery: two-letter codes of the languages the creator posts in, such as en or es.", "items": { "type": "string" } }, "creatorGender": { "title": "Creator gender", "enum": [ "any", "male", "female" ], "type": "string", "description": "Discovery, Instagram and TikTok.", "default": "any" }, "accountType": { "title": "Account type", "enum": [ "any", "human", "brand" ], "type": "string", "description": "Discovery, Instagram: a person or a brand.", "default": "any" }, "followersMin": { "title": "Minimum followers", "minimum": 0, "type": "integer", "description": "Discovery: followers (subscribers on YouTube) at least this many." }, "followersMax": { "title": "Maximum followers", "minimum": 0, "type": "integer", "description": "Discovery: followers (subscribers on YouTube) at most this many." }, "engagementRateMin": { "title": "Minimum engagement rate (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Discovery, Instagram, TikTok and Twitter: engagement rate in percent, from 0 to 100." }, "engagementRateMax": { "title": "Maximum engagement rate (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Discovery, Instagram, TikTok and Twitter: engagement rate in percent, from 0 to 100." }, "audienceQualityMin": { "title": "Minimum audience quality score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery, Instagram and TikTok: the provider's audience quality score (AQS), from 0 to 100." }, "audienceQualityMax": { "title": "Maximum audience quality score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery, Instagram and TikTok: audience quality score, from 0 to 100." }, "channelQualityMin": { "title": "Minimum channel quality score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery, YouTube: the provider's channel quality score (CQS), from 0 to 100." }, "channelQualityMax": { "title": "Maximum channel quality score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery, YouTube: channel quality score, from 0 to 100." }, "averageViewsMin": { "title": "Minimum average views", "minimum": 0, "type": "integer", "description": "Discovery, YouTube and TikTok: average views per video." }, "audienceCountries": { "title": "Audience countries", "type": "array", "description": "Discovery, Instagram, YouTube, TikTok and Twitch: two-letter codes of countries the audience must come from, each at least the share below.", "items": { "type": "string" } }, "audienceCountryMinPercent": { "title": "Audience country minimum share (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery: the least share of the audience each audience country must hold.", "default": 20 }, "audienceGender": { "title": "Audience gender", "enum": [ "any", "male", "female" ], "type": "string", "description": "Discovery, Instagram, YouTube, TikTok and Twitch: the gender the audience leans to, with the share below.", "default": "any" }, "audienceGenderMinPercent": { "title": "Audience gender minimum share (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery: the least share of the audience of that gender.", "default": 50 }, "audienceAgeGroups": { "title": "Audience age groups", "type": "array", "description": "Discovery, Instagram, YouTube and TikTok: age groups that together must hold the share below.", "items": { "type": "string", "enum": [ "13_17", "18_24", "25_34", "35_44", "45_54", "55_64", "65" ], "enumTitles": [ "13 to 17", "18 to 24", "25 to 34", "35 to 44", "45 to 54", "55 to 64", "65 and over" ] } }, "audienceAgeMinPercent": { "title": "Audience age minimum share (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery: the least share of the audience in the chosen age groups together.", "default": 30 }, "hasContacts": { "title": "Has contact details", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Discovery: only creators that list an email or other contact.", "default": "any" }, "hasAdvertising": { "title": "Has run sponsored posts", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Discovery, Instagram, YouTube and TikTok: creators that have or have not posted advertising.", "default": "any" }, "verified": { "title": "Verified", "enum": [ "any", "verified", "notVerified" ], "type": "string", "description": "Discovery, Instagram, TikTok, YouTube and Twitter.", "default": "any" }, "postedWithinDays": { "title": "Posted within days", "minimum": 1, "type": "integer", "description": "Discovery, Instagram, YouTube, TikTok and Twitter: the creator posted within this many days." }, "growthPeriod": { "title": "Follower growth period", "enum": [ "any", "7d", "30d", "90d", "180d", "365d" ], "type": "string", "description": "Discovery: the period follower growth is measured over, with the percent range below.", "default": "any" }, "growthMinPercent": { "title": "Follower growth minimum (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery: follower growth over the period, at least this percent." }, "growthMaxPercent": { "title": "Follower growth maximum (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Discovery: follower growth over the period, at most this percent." }, "youtubeContentType": { "title": "YouTube content type", "enum": [ "any", "video", "live" ], "type": "string", "description": "Discovery, YouTube: channels that post videos or that stream live.", "default": "any" }, "twitchGameIds": { "title": "Twitch game ids", "type": "array", "description": "Discovery, Twitch: up to 3 game ids the streamer plays, from the Twitch game ids service.", "items": { "type": "string" } }, "liveViewersMin": { "title": "Minimum average live viewers", "minimum": 0, "type": "integer", "description": "Discovery, Twitch." }, "liveViewersMax": { "title": "Maximum average live viewers", "minimum": 0, "type": "integer", "description": "Discovery, Twitch." }, "similarTo": { "title": "Similar to", "type": "string", "description": "Discovery, Instagram, YouTube and TikTok: find creators similar to this Instagram username, YouTube channel id or TikTok account id." }, "excludeUsernames": { "title": "Exclude usernames", "type": "array", "description": "Discovery: usernames to leave out of the results, up to 1000.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "engagement_avg", "subscribers_count", "er", "username" ], "type": "string", "description": "Discovery: the order results come in.", "default": "engagement_avg" }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Discovery.", "default": "desc" }, "useSandbox": { "title": "Use the discovery sandbox", "type": "boolean", "description": "Discovery: call the provider's sandbox, which returns sample creators without applying filters and spends no discovery requests. Good for testing a key. Sandbox rows are not charged.", "default": false }, "lookupBy": { "title": "Look up reports by", "enum": [ "username", "userId" ], "type": "string", "description": "Influencer audience report, Instagram and TikTok: usernames, or numeric user ids. Other networks always take the username or channel.", "default": "username" }, "reportType": { "title": "Report type", "enum": [ "advanced_report", "report" ], "type": "string", "description": "Influencer audience report, Instagram, YouTube and TikTok: the advanced report (1 report credit) or the mini report (1 mini report credit). Twitch and Twitter have one report type.", "default": "advanced_report" }, "reportFeatures": { "title": "Extra report features", "type": "array", "description": "Influencer audience report: extra sections to add. Instagram takes ranking, mentions, mentioned by, notable audience, audience brand affinity and ER benchmarks; YouTube takes brand mentions performance. Others are ignored.", "items": { "type": "string", "enum": [ "ranking", "mentions", "mentioned_by", "notable_audience", "audience_brand_affinity", "er_benchmarks", "blogger_mentions_performance" ], "enumTitles": [ "Ranking (Instagram)", "Mentions (Instagram)", "Mentioned by (Instagram)", "Notable audience (Instagram)", "Audience brand affinity (Instagram)", "ER benchmarks (Instagram)", "Brand mentions performance (YouTube)" ] } }, "includeRawReport": { "title": "Include the full report", "type": "boolean", "description": "Influencer audience report: keep the provider's whole report under raw, alongside the flattened columns.", "default": true }, "maxWaitSeconds": { "title": "Wait for new reports (seconds)", "minimum": 0, "maximum": 900, "type": "integer", "description": "Influencer audience report: how long to keep asking for a report the provider is still building. Asking again is free.", "default": 180 }, "suggesterNetwork": { "title": "Suggester network", "enum": [ "any", "instagram", "youtube", "tiktok", "twitch", "twitter", "snapchat" ], "type": "string", "description": "Account suggester: search one network only, or all of them.", "default": "any" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many rows. Discovery reads 20 creators per page and each page spends one discovery request on your plan, so this also caps what the run spends there. The provider serves at most 10,000 results per search.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 100, "type": "integer", "description": "Pacing ceiling for calls to the provider, which allows 100 per minute. Rate limited answers are retried after a pause.", "default": 60 }, "apiKey": { "title": "API token", "type": "string", "description": "Your own API token (X-Auth-Token), issued with HypeAuditor API access. This actor is bring-your-own-key and never ships one. Leave blank to use the DATA_API_KEY environment secret. It is sent only to the API host and is never written to a row or logged." }, "accountId": { "title": "Account id", "type": "string", "description": "Your account id, also called client id (X-Auth-Id), issued with the token. Required with the token. Leave blank to use the DATA_API_AUTH_ID environment secret." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }