{ "openapi": "3.0.1", "info": { "title": "Influencer Analytics API - Sponsorships, Brand Spend, CreatorDB", "description": "Search YouTube, Instagram and TikTok influencers by niche, country, followers and engagement, then pull profiles, contact emails, audience demographics, performance history, sponsorships and transcripts, plus brand spend, CPM and sponsored creators. Bring your own CreatorDB key.", "version": "0.1", "x-build-id": "s008OUdlpKm2AZxQg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~influencer-analytics-sponsorship-brand-spend-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-influencer-analytics-sponsorship-brand-spend-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-analytics-sponsorship-brand-spend-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-influencer-analytics-sponsorship-brand-spend-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-analytics-sponsorship-brand-spend-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-influencer-analytics-sponsorship-brand-spend-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": { "mode": { "title": "What to read", "enum": [ "searchCreators", "naturalLanguageSearch", "creatorProfiles", "creatorContacts", "creatorPerformance", "creatorPerformanceHistory", "creatorAudience", "creatorContent", "creatorSponsorships", "videoTranscripts", "topics", "niches", "searchBrands", "listBrands", "brandProfiles", "brandSponsoredCreators", "brandCreatorPerformance", "brandAudience", "brandSummaries", "usage" ], "type": "string", "description": "Creator search finds YouTube, Instagram or TikTok creators with the filters below. Natural language search takes a plain description. The creator modes read one row per creator (or per video, day or brand) for the creators listed below. YouTube video subtitles read transcripts for video IDs. Topics and niches list the taxonomy values the niche and topic filters take. The brand modes search and list sponsoring brands and read their sponsored creators, performance, audience and spend for the brand IDs listed below. API credit usage reads your key's usage per day.", "default": "searchCreators" }, "platform": { "title": "Platform", "enum": [ "youtube", "instagram", "tiktok" ], "type": "string", "description": "The platform for creator search, the creator modes and niches. Sponsorships and the brand sponsored creator modes cover YouTube and Instagram only. Natural language search picks the platform from the description.", "default": "youtube" }, "keyword": { "title": "Name keyword", "type": "string", "description": "Creator search. Fuzzy match on the creator display name, such as cooking or tech review." }, "creatorCountries": { "title": "Creator countries", "type": "array", "description": "Creator search. Countries the creator is based in, as three letter ISO 3166-1 alpha-3 codes such as USA, GBR, DEU, JPN.", "items": { "type": "string" } }, "creatorLanguages": { "title": "Content languages", "type": "array", "description": "Creator search. Main content language as three letter ISO 639-3 codes such as eng, spa, por, jpn.", "items": { "type": "string" } }, "niches": { "title": "Niches", "type": "array", "description": "Creator search. Niche IDs, as the niches mode lists them for the platform, such as id_smartphone_ScienceTechnology.", "items": { "type": "string" } }, "topics": { "title": "Topics (YouTube)", "type": "array", "description": "Creator search on YouTube. Topic IDs, as the topics mode lists them, such as id_gaming_Entertainment.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Creator search. The main channel category on YouTube, or the professional account category on Instagram and TikTok.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Creator search. Creators who use these hashtags (with or without #).", "items": { "type": "string" } }, "minFollowers": { "title": "Minimum followers", "minimum": 0, "type": "integer", "description": "Creator search. More than this many subscribers (YouTube) or followers (Instagram, TikTok)." }, "maxFollowers": { "title": "Maximum followers", "minimum": 0, "type": "integer", "description": "Creator search. Fewer than this many subscribers or followers." }, "minEngagementRate": { "title": "Minimum engagement rate", "minimum": 0, "maximum": 1, "type": "number", "description": "Creator search. Average engagement rate of recent content as a decimal, such as 0.03 for 3 percent: recent videos on YouTube and TikTok, recent posts and reels on Instagram." }, "minAvgViews": { "title": "Minimum average views", "minimum": 0, "type": "integer", "description": "Creator search. Average views of recent videos (YouTube, TikTok) or recent reels (Instagram)." }, "minFollowerGrowth30d": { "title": "Minimum 30 day follower growth", "minimum": 0, "type": "number", "description": "Creator search. Follower or subscriber growth rate over the last 30 days as a decimal, such as 0.05 for 5 percent." }, "postedWithinDays": { "title": "Posted within days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Creator search. Only creators whose last upload is within this many days." }, "hasEmail": { "title": "Has a business email", "type": "boolean", "description": "Creator search. Only creators with a contact email on file." }, "hasSponsors": { "title": "Has sponsored content", "type": "boolean", "description": "Creator search on YouTube and Instagram. Only creators who have published sponsored content." }, "verifiedOnly": { "title": "Verified accounts only", "type": "boolean", "description": "Creator search on Instagram and TikTok. Only verified accounts." }, "audienceCountries": { "title": "Main audience countries", "type": "array", "description": "Creator search. The country with the largest audience share, as ISO 3166-1 alpha-3 codes.", "items": { "type": "string" } }, "audienceGender": { "title": "Main audience gender", "enum": [ "any", "male", "female" ], "type": "string", "description": "Creator search. The dominant gender of the audience.", "default": "any" }, "audienceAge": { "title": "Main audience age", "enum": [ "any", "13-17", "18-24", "25-34", "35-44", "45-54", "55-64", "65+" ], "type": "string", "description": "Creator search. The primary age range of the audience. TikTok has no 13-17 group.", "default": "any" }, "advancedFilters": { "title": "Advanced filters", "type": "array", "description": "Creator search and brand search. Any other documented filter as a list of objects with filterName, op (=, in, >, <) and value, plus isFuzzySearch on string filters. Example: [{\"filterName\": \"avgRecentShortsViews\", \"op\": \">\", \"value\": 100000}]. Every filterName is checked against the documented list for the platform." }, "sortBy": { "title": "Sort creators by", "enum": [ "relevance", "followers", "engagementRate", "avgViews", "followerGrowth", "platformScore", "lastPublishTime", "displayName" ], "type": "string", "description": "Creator search. Mapped to the matching documented field on each platform.", "default": "followers" }, "sortDescending": { "title": "Sort descending", "type": "boolean", "description": "Creator search, brand search, the brand directory and the brand creator modes. Highest first.", "default": true }, "description": { "title": "Description", "type": "string", "description": "Natural language search. A description of the creators you want, up to 1000 characters, such as: US based YouTube beauty creators with over 1M subscribers." }, "creators": { "title": "Creators", "type": "array", "description": "The creator modes. One per line on the chosen platform: a YouTube channel ID (UC...), a handle such as @mrbeast or nike, or a profile URL (youtube.com/@name, youtube.com/channel/UC..., instagram.com/name, tiktok.com/@name).", "items": { "type": "string" } }, "pastDayRange": { "title": "History days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Creator performance history. How many past days of daily snapshots, 1 to 365. The provider charges more credits for longer ranges.", "default": 30 }, "videoIds": { "title": "Video IDs", "type": "array", "description": "YouTube video subtitles. One YouTube video ID or URL per line. The creator recent content mode lists video IDs.", "items": { "type": "string" } }, "subtitleLanguage": { "title": "Subtitle language", "type": "string", "description": "YouTube video subtitles. A two letter language code such as en, es or zh-Hant. Empty takes the first track." }, "preferHumanCaptions": { "title": "Prefer human captions", "type": "boolean", "description": "YouTube video subtitles. Take creator uploaded captions over auto-generated ones when both exist.", "default": true }, "brandName": { "title": "Brand name", "type": "string", "description": "Brand search. Fuzzy match on the brand name or alias, such as nike." }, "industries": { "title": "Industries", "type": "array", "description": "Brand search. Industry values from the provider's Industry List, such as Consumer Electronics or Video Games.", "items": { "type": "string" } }, "brandCountries": { "title": "Brand headquarters countries", "type": "array", "description": "Brand search. ISO 3166-1 alpha-3 codes.", "items": { "type": "string" } }, "sponsoringRegions": { "title": "Sponsoring regions", "type": "array", "description": "Brand search. Countries where the brand's sponsored creators are mainly based, as ISO 3166-1 alpha-3 codes.", "items": { "type": "string" } }, "sponsoringPlatforms": { "title": "Sponsoring platforms", "type": "array", "description": "Brand search. Brands with sponsorships on these platforms.", "items": { "type": "string", "enum": [ "youtube", "instagram" ], "enumTitles": [ "YouTube", "Instagram" ] } }, "sponsoredYoutubeChannelIds": { "title": "Sponsored YouTube channel IDs", "type": "array", "description": "Brand search. Brands that sponsored these YouTube channels.", "items": { "type": "string" } }, "sponsoredInstagramHandles": { "title": "Sponsored Instagram handles", "type": "array", "description": "Brand search. Brands that sponsored these Instagram accounts.", "items": { "type": "string" } }, "activeCampaignOnly": { "title": "Active campaign only", "type": "boolean", "description": "Brand search. Only brands with sponsored content in the last 30 days." }, "minEstimatedSpend30d": { "title": "Minimum estimated 30 day spend (USD)", "minimum": 0, "type": "integer", "description": "Brand search. Estimated spend on sponsored YouTube creators over the last 30 days." }, "brandSortBy": { "title": "Sort brands by", "enum": [ "totalSponsoredContent", "name", "estimatedTotalSpend7d", "estimatedTotalSpend30d", "estimatedTotalSpend90d" ], "type": "string", "description": "Brand search (all choices) and the brand directory (name or total sponsored content).", "default": "totalSponsoredContent" }, "brandIds": { "title": "Brand IDs", "type": "array", "description": "The brand modes. One brand ID per line, usually the brand's main domain such as nike.com; brand search lists them.", "items": { "type": "string" } }, "sponsoredCreatorSortBy": { "title": "Sort sponsored creators by", "enum": [ "lastSponsoredDate", "followers", "avgRecentSponsoredEngagementRate", "sponsoredCount" ], "type": "string", "description": "Brand sponsored creators.", "default": "lastSponsoredDate" }, "sponsoredPerformanceSortBy": { "title": "Sort sponsored performance by", "enum": [ "publishTime", "views", "likes", "engagementRate" ], "type": "string", "description": "Brand sponsored creator performance. Averages across the brand's sponsored content per creator.", "default": "publishTime" }, "usageStartDate": { "title": "Usage start date", "type": "string", "description": "API credit usage. YYYY-MM-DD. Defaults to 7 days ago." }, "usageEndDate": { "title": "Usage end date", "type": "string", "description": "API credit usage. YYYY-MM-DD, at most 365 days after the start. Defaults to today." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Row cap for the run. Searches page 100 rows a call and stop here.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 300, "type": "integer", "description": "Pacing of calls to the provider. Lower it if the provider rate limits your key.", "default": 60 }, "apiKey": { "title": "CreatorDB API key", "type": "string", "description": "Your own CreatorDB API key (API, then Create key, in the CreatorDB dashboard). Optional here if the DATA_API_KEY secret is set. Never logged." } } }, "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 } } } } } } } } } }