{ "openapi": "3.0.0", "paths": { "/health": { "get": { "operationId": "AppController_getHealth", "summary": "Health check", "description": "The health endpoint provides a real-time status of the API, indicating whether the system is Healthy, Degraded, or Unhealthy based on the performance of recent requests.
Note: The service health calculation includes all Discovery endpoints but excludes Raw Data endpoints.", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } } }, "tags": [ "System" ] } }, "/instagram/search": { "post": { "operationId": "InstagramController_search", "summary": "Search Influencers", "description": "

Get a list of influencers that match your filters.\n\t\t\t
A successful request costs 0.01 credits per search result, with a typical request totaling 0.15 credits for up to 15 results per page

\n\t\t\t
Audience filters support weights:
Expand to see additional information

Weights allow you to set a threshold for the chosen filter. If you remove the weight - we will apply the default weight per filter.\n\t\t\t
Using multiple filters simultaneously results in a logical AND, while applying multiple objects into an array (works with interests, location and age) are applied as a logical OR\n\t\t\t

Example: If you want at least 30% of the audience to be at the age of 18-24, you can use the weight property of 0.3. We recommend starting with low weight and gradually increasing the percentage. You can find the default thresholds in the notes of each filter.
\n\t\t\t

Expand the filter object below to see all available options.\n\t\t\t", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstagramSearchBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/profile/{userId}/report": { "get": { "operationId": "InstagramController_report", "summary": "Get Influencer Report", "description": "To protect our enterprise customers, influencer contact details are not enabled by default. [Contact us](mailto:hello@modash.io) to unlock them for free.
\t\t\tEvery successful request costs 1 credit.", "parameters": [ { "name": "userId", "required": true, "in": "path", "description": "User's Instagram handle or user ID from Instagram", "example": "mrbeast", "schema": { "type": "string" } }, { "name": "calculationMethod", "required": false, "in": "query", "description": "If specified, this indicates the method used to compute average-based metrics, such as average number of likes, comments, shares, etc.", "schema": { "default": "median", "enum": [ "median", "average" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstagramReport" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/collaborations/influencer": { "get": { "operationId": "InstagramController_brandTimelineInfluencer", "summary": "Get Influencer Collaborations", "description": "

Get Brand collaborations for Influencer. This will provide posts for any platform.\n\t\t\t
A successful request costs 1 credit, for up to 30 results per page

\n\t\t\t
\n\tThis endpoint is deprecated and will be removed in the future. Please use the new, improved and cheaper Collaborations endpoint instead.\n
", "deprecated": true, "parameters": [ { "name": "influencerId", "required": true, "in": "path", "description": "Influencer's Instagram user ID from Instagram", "schema": { "type": "string" } }, { "name": "after", "required": false, "in": "path", "description": "Cursor for pagination", "schema": { "type": "string" } }, { "name": "groupedBrands", "required": false, "in": "path", "description": "Group brands by domain", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsInfluencerResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/collaborations/brand": { "get": { "operationId": "InstagramController_brandTimelineBrand", "summary": "Get Brand Collaborations", "description": "

Get Brand collaborations for Brand. This will provide posts for any platform.\n\t\t\t
A successful request costs 1 credit, for up to 30 results per page

\n\t\t\t
\n\tThis endpoint is deprecated and will be removed in the future. Please use the new, improved and cheaper Collaborations endpoint instead.\n
", "deprecated": true, "parameters": [ { "name": "brandId", "required": true, "in": "path", "description": "Brand's Instagram user ID from Instagram", "schema": { "type": "string" } }, { "name": "after", "required": false, "in": "path", "description": "Cursor for pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsInfluencerResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/reports/audience/overlap": { "post": { "operationId": "InstagramController_influencersAudienceOverlap", "summary": "Audience overlap reports", "description": "Check audience (followers) overlap for several influencers.\n\t\t
A successful request costs 1 credit.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiencerOverlapBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudienceOverlapResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/brands": { "get": { "operationId": "InstagramController_brands", "summary": "List Partnerships (brands)", "description": "Search the list of Partnerships (brands) that have worked with the influencer.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBrandsResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/interests": { "get": { "operationId": "InstagramController_interests", "summary": "List Interests", "description": "Search the list of interests.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInterestsResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/topics": { "get": { "operationId": "InstagramController_topics", "summary": "List Topics", "description": "Search for topics.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "travel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashtagsResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/languages": { "get": { "operationId": "InstagramController_languages", "summary": "List Languages", "description": "Search the list of languages for Influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLanguagesResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/locations": { "get": { "operationId": "InstagramController_locations", "summary": "List Locations", "description": "Search the list of locations for Influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLocationsResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/users": { "get": { "operationId": "InstagramController_users", "summary": "List Users", "description": "Search the list of influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "mrbeast", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/instagram/hashtags": { "get": { "operationId": "InstagramController_hashtags", "summary": "List Hashtags", "description": "Search for hashtags.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "travel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashtagsResponse" } } } } }, "tags": [ "Instagram" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/search": { "post": { "operationId": "TikTokController_search", "summary": "Search Influencers", "description": "

Get a list of influencers that match your filters.\n\t\t\t
A successful request costs 0.01 credits per search result, with a typical request totaling 0.15 credits for up to 15 results per page

\n\t\t\t
Audience filters support weights:
Expand to see additional information

Weights allow you to set a threshold for the chosen filter. If you remove the weight - we will apply the default weight per filter.\n\t\t\t
Using multiple filters simultaneously results in a logical AND, while applying multiple objects into an array (works with location and age) are applied as a logical OR\n\t\t\t

Example: If you want at least 30% of the audience to be at the age of 18-24, you can use the weight property of 0.3. We recommend starting with low weight and gradually increasing the percentage. You can find the default thresholds in the notes of each filter.
\n\t\t\t

Expand the filter object below to see all available options.\n\t\t\t", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTokSearchBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/profile/{userId}/report": { "get": { "operationId": "TikTokController_report", "summary": "Get Influencer report", "description": "Influencer contact details are not enabled by default. [Contact us](mailto:hello@modash.io) to unlock this data for free.
\t\t\t\tEvery successful request costs 1 credit.", "parameters": [ { "name": "userId", "required": true, "in": "path", "description": "User's TikTok handle or user ID from TikTok", "example": "@claudinelanglois", "schema": { "type": "string" } }, { "name": "calculationMethod", "required": false, "in": "query", "description": "If specified, this indicates the method used to compute average-based metrics, such as average number of likes, comments, shares, etc.", "schema": { "default": "median", "enum": [ "median", "average" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTokReport" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/collaborations/influencer": { "get": { "operationId": "TikTokController_brandTimelineInfluencer", "summary": "Get Influencer Collaborations", "description": "

Get Brand collaborations for Influencer. This will provide posts for any platform.\n\t\t\t
A successful request costs 1 credit, for up to 30 results per page

\n\t\t\t
\n\tThis endpoint is deprecated and will be removed in the future. Please use the new, improved and cheaper Collaborations endpoint instead.\n
", "deprecated": true, "parameters": [ { "name": "influencerId", "required": true, "in": "path", "description": "Influencer's Tiktok secUid from Tiktok", "schema": { "type": "string" } }, { "name": "after", "required": false, "in": "path", "description": "Cursor for pagination", "schema": { "type": "string" } }, { "name": "groupedBrands", "required": false, "in": "path", "description": "Group brands by domain", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsInfluencerResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/collaborations/brand": { "get": { "operationId": "TikTokController_brandTimelineBrand", "summary": "Get Brand Collaborations", "description": "

Get Brand collaborations for Brand. This will provide posts for any platform.\n\t\t\t
A successful request costs 1 credit, for up to 30 results per page

\n\t\t\t
\n\tThis endpoint is deprecated and will be removed in the future. Please use the new, improved and cheaper Collaborations endpoint instead.\n
", "deprecated": true, "parameters": [ { "name": "brandId", "required": true, "in": "path", "description": "Brand's Tiktok secUid from Tiktok", "schema": { "type": "string" } }, { "name": "after", "required": false, "in": "path", "description": "Cursor for pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsInfluencerResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/languages": { "get": { "operationId": "TikTokController_languages", "summary": "List Languages", "description": "Search the list of languages for Influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLanguagesResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/locations": { "get": { "operationId": "TikTokController_locations", "summary": "List Locations", "description": "Search the list of locations for Influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLocationsResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/users": { "get": { "operationId": "TikTokController_users", "summary": "List Users", "description": "Search the list of influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "mrbeast", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/topics": { "get": { "operationId": "TikTokController_topics", "summary": "List Topics", "description": "Search for topics.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "travel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashtagsResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/tiktok/hashtags": { "get": { "operationId": "TikTokController_hashtags", "summary": "List Hashtags", "description": "Search for hashtags.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "travel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashtagsResponse" } } } } }, "tags": [ "TikTok" ], "security": [ { "accessToken": [] } ] } }, "/youtube/search": { "post": { "operationId": "YouTubeController_search", "summary": "Search Influencers", "description": "

Get a list of influencers that match your filters.\n\t\t\t
A successful request costs 0.01 credits per search result, with a typical request totaling 0.15 credits for up to 15 results per page

\n\t\t\t
Audience filters support weights:
Expand to see additional information

Weights allow you to set a threshold for the chosen filter. If you remove the weight - we will apply the default weight per filter.\n\t\t\t
Using multiple filters simultaneously results in a logical AND, while applying multiple objects into an array (works with location and age) are applied as a logical OR\n\t\t\t

Example: If you want at least 30% of the audience to be at the age of 18-24, you can use the weight property of 0.3. We recommend starting with low weight and gradually increasing the percentage. You can find the default thresholds in the notes of each filter.
\n\t\t\t

Expand the filter object below to see all available options.\n\t\t\t", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YouTubeSearchBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YoutubeSearchResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/profile/{userId}/report": { "get": { "operationId": "YouTubeController_report", "summary": "Get Influencer report", "description": "Influencer contact details are not enabled by default. [Contact us](mailto:hello@modash.io) to unlock this data for free.
\t\t\t\tEvery successful request costs 1 credit.", "parameters": [ { "name": "userId", "required": true, "in": "path", "description": "User's YouTube handle or user ID from YouTube", "example": "@MrBeast", "schema": { "type": "string" } }, { "name": "calculationMethod", "required": false, "in": "query", "description": "If specified, this indicates the method used to compute average-based metrics, such as average number of likes, comments, shares, etc.", "schema": { "default": "median", "enum": [ "median", "average" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YouTubeReport" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/collaborations/influencer": { "get": { "operationId": "YouTubeController_brandTimelineInfluencer", "summary": "Get Influencer Collaborations", "description": "

Get Brand collaborations for Influencer. This will provide posts for any platform.\n\t\t\t
A successful request costs 1 credit, for up to 30 results per page

\n\t\t\t
\n\tThis endpoint is deprecated and will be removed in the future. Please use the new, improved and cheaper Collaborations endpoint instead.\n
", "deprecated": true, "parameters": [ { "name": "influencerId", "required": true, "in": "path", "description": "Influencer's Youtube channelId from Youtube", "schema": { "type": "string" } }, { "name": "after", "required": false, "in": "path", "description": "Cursor for pagination", "schema": { "type": "string" } }, { "name": "groupedBrands", "required": false, "in": "path", "description": "Group brands by domain", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsInfluencerResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/languages": { "get": { "operationId": "YouTubeController_languages", "summary": "List Languages", "description": "Search the list of languages for Influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLanguagesResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/locations": { "get": { "operationId": "YouTubeController_locations", "summary": "List Locations", "description": "Search the list of locations for Influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "ita", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLocationsResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/reports/audience/overlap": { "post": { "operationId": "YouTubeController_influencersAudienceOverlap", "summary": "Audience overlap reports", "description": "Check audience (followers) overlap for several influencers.\n\t\t
A successful request costs 1 credit.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudiencerOverlapBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudienceOverlapResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/users": { "get": { "operationId": "YouTubeController_users", "summary": "List Users", "description": "Search the list of influencers.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "mrbeast", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YoutubeListUsersResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/topics": { "get": { "operationId": "YouTubeController_topics", "summary": "List Topics", "description": "Search for topics.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "travel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashtagsResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/youtube/hashtags": { "get": { "operationId": "YouTubeController_hashtags", "summary": "List Hashtags", "description": "Search for hashtags.\n\t\t
A successful request costs 0 credits.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Max items to get", "example": 1000, "schema": { "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "String to search by", "example": "travel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashtagsResponse" } } } } }, "tags": [ "YouTube" ], "security": [ { "accessToken": [] } ] } }, "/user/info": { "get": { "operationId": "UserController_info", "summary": "Get User Account Info", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "description": "If there is an error", "type": "boolean" }, "user": { "type": "object", "properties": { "name": { "examples": "Jane Doe", "description": "Deprecated field, it is always empty. We will remove this field in the next version of the API.", "type": "string" }, "email": { "examples": "janedoe@example.com", "description": "Deprecated field, it is always empty. We will remove this field in the next version of the API.", "type": "string" } } }, "billing": { "type": "object", "properties": { "credits": { "examples": 500.5, "type": "number" }, "rawRequests": { "example": 4500, "type": "number" } }, "required": [ "rawRequests" ] }, "rateLimits": { "type": "object", "properties": { "discoveryRatelimit": { "example": 500, "type": "number" }, "rawRatelimit": { "example": 500, "type": "number" } }, "required": [ "discoveryRatelimit", "rawRatelimit" ] } }, "required": [ "error", "user", "billing", "rateLimits" ] } } } } }, "tags": [ "User Account" ], "security": [ { "accessToken": [] } ] } }, "/email-search": { "post": { "operationId": "MultiPlatformController_emailSearch", "summary": "Search by Email", "description": "For each email provided, identify one or more social media accounts on Instagram, YouTube, or TikTok that have listed this email in their bio or as their contact information.\n\t\t
A successful request costs 0.02 credits per matched email. To execute this request, the account must have a minimum of 0.02 credits multiplied by the number of provided emails, otherwise a not_enough_credits error will be returned.\n\t\t
We do not store the email addresses that you send us.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailsSearchBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailsSearchResponse" } } } } }, "tags": [ "" ], "security": [ { "accessToken": [] } ] } }, "/collaborations/posts": { "post": { "operationId": "CollaborationsController_posts", "summary": "Get collaboration posts", "description": "This endpoint returns collaborated posts where influencers mention brands or vice versa.
\t\t\tEvery successful request costs 0.2 credit.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsPostsRequest" }, "examples": { "default": { "value": { "id": "cristiano", "platform": "instagram", "limit": 10 } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsPostsResponse" } } } }, "404": { "description": "No data found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsNotFoundResponse" } } } } }, "tags": [ "Collaborations" ], "security": [ { "accessToken": [] } ] } }, "/collaborations/summary": { "post": { "operationId": "CollaborationsController_summary", "summary": "Get collaboration summary", "description": "This endpoint aggregates performance data (total as well as per_brand/per_influencer) across the collaborated posts, including total_likes, total_shares, total_views, total_collects, and total_plays.
\t\t\tEvery successful request costs 0.2 credit.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsSummaryRequest" }, "examples": { "default": { "value": { "id": "cristiano", "platform": "instagram", "limit": 10 } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsSummaryResponse" } } } }, "404": { "description": "No data found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsNotFoundResponse" } } } } }, "tags": [ "Collaborations" ], "security": [ { "accessToken": [] } ] } }, "/ai/text-search": { "post": { "operationId": "AISearchController_textSearch", "summary": "Instagram Text-based AI Search", "description": "Search for influencers using a text based query i.e. \"woman with curly hair lifting weights\" (along with other filters). This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "deprecated": true, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGTextAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/image-search": { "post": { "operationId": "AISearchController_imageSearch", "summary": "Instagram Image-based AI Search", "description": "Search for influencers using an image based query (along with other filters) and you will get influencers who have posted content similar to the query image. This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "deprecated": true, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGImageAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/instagram/text-search": { "post": { "operationId": "AISearchController_igTextSearch", "summary": "Instagram Text-based AI Search", "description": "Search for influencers using a text based query i.e. \"woman with curly hair lifting weights\" (along with other filters). This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGTextAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/instagram/image-search": { "post": { "operationId": "AISearchController_igImageSearch", "summary": "Instagram Image-based AI Search", "description": "Search for influencers using an image based query (along with other filters) and you will get influencers who have posted content similar to the query image. This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGImageAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/tiktok/text-search": { "post": { "operationId": "AISearchController_ttTextSearch", "summary": "TikTok Text-based AI Search", "description": "Search for influencers using a text based query i.e. \"woman with curly hair lifting weights\" (along with other filters). This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TTAiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/tiktok/image-search": { "post": { "operationId": "AISearchController_ttImageSearch", "summary": "TikTok Image-based AI Search", "description": "Search for influencers using an image based query (along with other filters) and you will get influencers who have posted content similar to the query image. This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TTAiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/youtube/text-search": { "post": { "operationId": "AISearchController_ytTextSearch", "summary": "YouTube Text-based AI Search", "description": "Search for influencers using a text based query i.e. \"woman with curly hair lifting weights\" (along with other filters). This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YTTextAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YTAiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/youtube/image-search": { "post": { "operationId": "AISearchController_ytImageSearch", "summary": "YouTube Image-based AI Search", "description": "Search for influencers using an image based query (along with other filters) and you will get influencers who have posted content similar to the query image. The image is matched against video and short thumbnails. This API has a fixed 1 RPS limit for searches. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageAiSearchRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YTAiSearchResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/instagram/lookalikes": { "post": { "operationId": "AISearchController_igLookalikes", "summary": "Instagram Creator Lookalikes", "description": "Find creators similar to a given Instagram creator on any platform. Provide the source creator's user ID or username and a target platform. Results include similar creators with their profiles and posts. This API has a fixed 1 RPS limit. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGLookalikeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGLookalikeResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/tiktok/lookalikes": { "post": { "operationId": "AISearchController_ttLookalikes", "summary": "TikTok Creator Lookalikes", "description": "Find creators similar to a given TikTok creator on any platform. Provide the source creator's user ID or username and a target platform. Results include similar creators with their profiles and posts. This API has a fixed 1 RPS limit. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TTLookalikeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TTLookalikeResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/youtube/lookalikes": { "post": { "operationId": "AISearchController_ytLookalikes", "summary": "YouTube Creator Lookalikes", "description": "Find creators similar to a given YouTube creator on any platform. Provide the source creator's user ID or username and a target platform. Results include similar creators with their profiles and posts. This API has a fixed 1 RPS limit. Each resulting profile costs 0.025 credits.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YTLookalikeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YTLookalikeResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } }, "/ai/brands": { "get": { "operationId": "AISearchController_brandsDictionary", "summary": "Brands Dictionary", "description": "Get a list of brands that match the search query. Results from this endpoint are only valid for AI Search filters. Just like other dictionary endpoints, this endpoints costs nothing and there are no strict rate limits.", "parameters": [ { "name": "query", "required": false, "in": "query", "description": "Fuzzy search based on brand's name", "example": "coca cola", "schema": { "minLength": 1, "maxLength": 255, "type": "string" } }, { "name": "domain", "required": false, "in": "query", "description": "Exact match based on brand's domain", "schema": { "minLength": 1, "maxLength": 255, "type": "string" } }, { "name": "platform", "required": false, "in": "query", "description": "Platform (specify if you want to filter the results by platform)", "example": "instagram", "schema": { "enum": [ "instagram", "tiktok", "youtube" ], "type": "string" } }, { "name": "userId", "required": false, "in": "query", "description": "Exact match based on brand's user ID (only works for Instagram and Tiktok; for Youtube use domain field instead)", "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandsDictionaryResponse" } } } } }, "tags": [ "AI Search" ], "security": [ { "accessToken": [] } ] } } }, "info": { "title": "Overview", "description": "Discovery API provides powerful products for different use cases. Let us provide a brief overview:\n\nSearch allows you to build comprehensive search experience to find creators. Use filters, lookalikes and our dictionaries and lists to create stunning user interfaces.\n\nReports provide in depth analytics that include audience demographics, performance metrics, sponsored posts and much more.\n\nOur collaborations products enable you to create overviews of past brand partnerships between creators and brands.\n\nThere is more: Search by Email allows you to lookup which creator accounts are associated with an emails and audience overlap identifies the uniqueness of an audience with ease.\n\n# Testing the API\n\n## Search\n\nYou can test out the [Instagram Search API](#tag/Instagram/paths/~1instagram~1search/post) for free by leaving the filter object empty. Your request body should look similar to this.\n\n```\n> POST https://api.modash.io/v1/instagram/search\n{\n\t\"sort\": {\n\t\t\"field\": \"followers\",\n\t\t\"direction\": \"desc\"\n\t},\n\t\"filter\": {\n\t}\n}\n```\n\n## Reports\n\nTo test out the [Instagram Reports API](#tag/Instagram/paths/~1instagram~1profile~1{userId}~1report/get) for free you can set the `userId` as `instagram`.\nYour request should look like this.\n\n```\n> GET https://api.modash.io/v1/instagram/profile/instagram/report\n```\n\nWe recommend always using the report route and caching the result if necessary. Everything that is included in the overview is also in a report.\n\n# Pagination\n\nWhen using the Search API, each response has in total 15 influencers. If you wish to query more influencers for the same query you need to increment the `page` parameter in the request body.\n\nBy default the `page` parameter is set to `0`.\n\n# Dictionaries\n\n## Interests, Locations and brands\n\nWhen finding influencers by interests, locations or brands you need to search by their respective ID. To list all interests, locations or brands you need to call the `https://api.modash.io/v1/instagram/interests`, `https://api.modash.io/v1/instagram/locations`, `https://api.modash.io/v1/instagram/brands` route.\n\nYou can specify the list of interests, locations or brands returned by using the `query` parameter and limit the amount of list items returned by using the `limit` parameter.\n\nBy default the `limit` parameter is set to `20`. You can query all list items by setting the `limit` parameter to `1000000`.\n\n## Languages\n\nSimilar to interests, locations and brands, you first need to find the correct language code to search by. This can be done by calling the `https://api.modash.io/v1/instagram/languages` route.\n", "version": null, "contact": { "name": "API Support", "url": "https://www.modash.io", "email": "hello@modash.io" }, "termsOfService": "https://www.modash.io/legal/terms-of-service" }, "tags": [ { "name": "", "description": null }, { "name": "YouTube", "description": "API for receiving data about YouTube influencers" }, { "name": "TikTok", "description": "API for receiving data about TikTok influencers" }, { "name": "Instagram", "description": "API for receiving data about Instagram influencers" }, { "name": "AI Search", "description": "AI Search allows you to find influencers based on the type of content they create, specifically by analyzing the images and videos that they post. It is available to all Discovery API users.\n\n\tP.S. it currently only supports Instagram influencers who have greater than 10000 followers." }, { "name": "Collaborations", "description": "These endpoints return posts or summaries for the collaborations between influencers and brands. These APIs can help you monitor partnerships, analyze campaign performance, track competitor activity, and power influencer discovery or reporting tools at scale." }, { "name": "User Account", "description": "API for Modash user account management" }, { "name": "System", "description": "System endpoints for service health and monitoring" } ], "servers": [ { "url": "https://api.modash.io/v1" } ], "components": { "securitySchemes": { "accessToken": { "scheme": "bearer", "bearerFormat": "token", "description": "Please enter token in following format: Bearer \\", "name": "Authorization", "type": "http", "in": "header" } }, "schemas": { "HealthDetail": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Endpoint path" }, "status": { "type": "string", "description": "Endpoint status" } }, "required": [ "endpoint", "status" ] }, "Health": { "type": "object", "properties": { "status": { "type": "string", "description": "API health status:
", "example": "healthy", "enum": [ "healthy", "degraded", "unhealthy" ] }, "details": { "description": "Health details by endpoint", "example": [ { "endpoint": "email-search", "status": "healthy" } ], "type": "array", "items": { "$ref": "#/components/schemas/HealthDetail" } } }, "required": [ "status", "details" ] }, "InstagramSort": { "type": "object", "properties": { "field": { "type": "string", "example": "followers", "default": "followers", "description": "Note: The following sort options are available only when the corresponding filter is applied: `keywords` `audienceGeo` `audienceLang` `audienceGender` `audienceAge` `audienceInterest` `followersGrowth`.
\n\t\tSorting field in which order you want to get the results.", "enum": [ "engagements", "followers", "engagementRate", "keywords", "audienceGeo", "audienceLang", "audienceGender", "audienceAge", "audienceRelevance", "relevance", "followersGrowth", "audienceInterest", "reelsPlays" ] }, "value": { "type": "number", "example": 123, "description": "Only required for ```audienceGeo``` and ```audienceInterest``` sorting." }, "direction": { "type": "string", "example": "desc", "default": "desc", "description": "Sorting direction", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] }, "FollowersCount": { "type": "object", "properties": { "min": { "type": "number", "example": 20000, "description": "Minimum follower count." }, "max": { "type": "number", "example": 70000, "description": "Maximum follower count." } } }, "InfluencerAgeRange": { "type": "object", "properties": { "min": { "type": "number", "example": 18, "description": "Minimum influencer age.", "enum": [ 18, 25, 35, 45, 65 ] }, "max": { "type": "number", "example": 25, "description": "Maximum influencer age.", "enum": [ 18, 25, 35, 45, 65 ] } } }, "GrowthFilter": { "type": "object", "properties": { "interval": { "type": "string", "description": "Specifies the interval of time in which growth occurred.", "enum": [ "i1month", "i2months", "i3months", "i4months", "i5months", "i6months" ], "example": "i1month" }, "value": { "type": "number", "description": "Weight of growth rate.", "example": 0.4 }, "operator": { "type": "string", "description": "Operator used for comparison.", "example": "gt", "enum": [ "gte", "gt", "lt", "lte" ] } }, "required": [ "interval", "operator" ] }, "ContactFilter": { "type": "object", "properties": { "contactType": { "type": "string", "example": "email", "enum": [ "bbm", "email", "facebook", "instagram", "itunes", "kakao", "kik", "lineid", "linktree", "pinterest", "sarahah", "sayat", "skype", "snapchat", "tiktok", "tumblr", "twitchtv", "twitter", "vk", "wechat", "youtube" ], "description": "Specifies the contact channels of an influencer." }, "filterAction": { "type": "string", "example": "must", "enum": [ "must", "should", "not" ], "default": "must", "description": "Defines condition enforced by the filter - \"must\" include, \"should\" include, or must \"not\" include." } }, "required": [ "contactType" ] }, "TextTag": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "hashtag", "mention" ], "description": "The type of the tag." }, "value": { "type": "string", "description": "The hashtag or mention without `@` or `#` in front of it." } }, "required": [ "type", "value" ] }, "ReelsPlaysCount": { "type": "object", "properties": { "min": { "type": "number", "example": 20000, "description": "Minimum reels plays count." }, "max": { "type": "number", "example": 50000000, "description": "Maximum reels plays count." } } }, "EngagementsCount": { "type": "object", "properties": { "min": { "type": "number", "example": 5000, "description": "Minimum engagements count (this value will be rounded)." }, "max": { "type": "number", "example": 10000, "description": "Maximum engagements count (this value will be rounded)." } } }, "InstagramFilterOperations": { "type": "object", "properties": { "operator": { "type": "string", "description": "Logical operations used to combine filters.
Note: To use the `or` operator, you must apply it to at least two filters.", "enum": [ "and", "or", "not" ] }, "filter": { "type": "string", "description": "Filter to apply the operation on. If `keywords` or `relevance` are specified then you can not sort by these fields.", "enum": [ "followers", "engagements", "engagementRate", "lastposted", "bio", "keywords", "relevance", "language", "gender", "age", "location", "isVerified", "interests", "brands", "accountTypes", "hasSponsoredPosts", "textTags" ] } }, "required": [ "operator", "filter" ] }, "InstagramSearchInfluencerFilters": { "type": "object", "properties": { "followers": { "example": { "min": 20000, "max": 70000 }, "description": "We round followers value in the filter: whenever it's below 5k, we round it to the nearest thousand (4123 -> 4000; 4800-> 5000); when it's over 5k, we round it to the nearest 5,000 (27k -> 25k; 28k -> 30k).", "allOf": [ { "$ref": "#/components/schemas/FollowersCount" } ] }, "engagementRate": { "type": "number", "description": "Minimum engagement rate.", "maximum": 1, "minimum": 0, "example": 0.02 }, "location": { "example": [ 148838, 62149, 80500, 1428125, 304716 ], "description": "Filter by Influencer Location, You can get the locations with our locations api end point and send location ids in an array.", "maxItems": 20, "type": "array", "items": { "type": "number" } }, "language": { "type": "string", "example": "en", "description": "Filter by Influencer Language, You can get the languages code with our languages api end point.", "minLength": 1, "maxLength": 3 }, "lastposted": { "type": "number", "example": 90, "description": "Idenitfy influencers based on when they last posted. The number represents days and should be >= 30.", "minimum": 30 }, "relevance": { "example": [ "#cars", "@topgear" ], "description": "Filter by topic of influencers posts or by similarity of topic to other influencer. For example \"#cars #audi @topgear\" means \"Writing about #cars and #audi, has similar topic as @topgear account.\" You can only enter 100 usernames.", "type": "array", "items": { "type": "string" } }, "audienceRelevance": { "example": [ "@topgear" ], "description": "Filter by similarity of influencer's audience to another influencer's audience. For example \"@topgear\" means \"Has audience similar to @topgear account.\" Audience similarity means followers follow accounts with the same topics as those followed by @topgear's audience.", "type": "array", "items": { "type": "string" } }, "gender": { "type": "string", "example": "MALE", "description": "Filter by Influencer gender.", "enum": [ "MALE", "FEMALE", "KNOWN", "UNKNOWN" ] }, "age": { "description": "Filter by Influencer age, possible values are: 18, 25, 35, 45, 65. You have the option to utilize either the `min` field, the `max` field, or both concurrently. Any number that falls outside the accepted range will be disregarded.", "allOf": [ { "$ref": "#/components/schemas/InfluencerAgeRange" } ] }, "followersGrowthRate": { "description": "Growth rate by followers over a period of time.", "example": { "interval": "i6months", "value": 0.01, "operator": "gt" }, "allOf": [ { "$ref": "#/components/schemas/GrowthFilter" } ] }, "bio": { "type": "string", "example": "photos videos", "description": "Search influencer by their bio description and/or full name" }, "hasAudienceData": { "type": "boolean", "description": "Filter by whether the influencer has audience data available. If true, shows only accounts with audience data. If false, shows all accounts including those without audience data. If not specified, defaults to true." }, "hasYouTube": { "type": "boolean", "example": false, "description": "If Influencer has a youtube channel." }, "hasContactDetails": { "description": "If Influencer has contact details.", "type": "array", "items": { "$ref": "#/components/schemas/ContactFilter" } }, "accountTypes": { "example": [ 2 ], "description": "Identify influencers by their Instagram account type: Regular = 1, Business = 2, Creator = 3. E.g to find business accounts use: 2", "type": "array", "items": { "type": "number" } }, "brands": { "example": [ 1708, 13 ], "description": "Filter by Influencer Brands, You can get the array of brands with our brands API endpoint and send brand ids in an array.", "type": "array", "items": { "type": "number" } }, "interests": { "example": [ 3, 21, 1, 13, 11, 1708, 7, 1826 ], "description": "Filter by Influencer Interests, You can get the array of interests with our interests api end point and send interests ids in an array.", "type": "array", "items": { "type": "number" } }, "keywords": { "type": "string", "description": "Identify influencers by a phrase they use within the caption of their post.", "example": "supercars" }, "textTags": { "example": [ { "type": "hashtag", "value": "carsofinstagram" }, { "type": "mention", "value": "topgear" } ], "maxItems": 20, "description": "Filter by influencers who have used the defined hashtags or mentions in their posts. ", "type": "array", "items": { "$ref": "#/components/schemas/TextTag" } }, "reelsPlays": { "description": "We round reels plays value in the filter to the nearest thousand (1400 -> 1k; 1500-> 2k)", "allOf": [ { "$ref": "#/components/schemas/ReelsPlaysCount" } ] }, "isVerified": { "type": "boolean", "description": "Set to `true` to filter by verified influencers." }, "hasSponsoredPosts": { "type": "boolean", "description": "Set to `true` to filter by influencers who have sponsored posts. We identify sponsored posts by looking for commercial hashtags or the official paid partnership tag." }, "engagements": { "description": "Filter by engagements count. Pro tip: set `max` to 0 if you want to see results with hidden likes.", "allOf": [ { "$ref": "#/components/schemas/EngagementsCount" } ] }, "filterOperations": { "description": "Modify filter operation to use `and`, `or`, or `not`. Example: Search for influencer using the keyword *cars* AND `not` from the London or Female `or` interested in Beauty & Cosmetics.
If no operator is specified, the default operator applied is the `and` operator.", "type": "array", "items": { "$ref": "#/components/schemas/InstagramFilterOperations" } } } }, "LocationWeightedFilter": { "type": "object", "properties": { "weight": { "type": "number", "description": "Weight of filter.", "maximum": 1, "minimum": 0, "example": 0.4 }, "id": { "type": "number", "description": "Filter value id for location (e.g. 148838)" } }, "required": [ "id" ] }, "LanguageWeightedFilter": { "type": "object", "properties": { "weight": { "type": "number", "description": "Weight of filter.", "maximum": 1, "minimum": 0, "example": 0.4 }, "id": { "type": "string", "description": "Filter value id for language (e.g. \"en\")", "minLength": 1, "maxLength": 2 } }, "required": [ "id" ] }, "GenderWeightedFilter": { "type": "object", "properties": { "weight": { "type": "number", "description": "Weight of filter.", "maximum": 1, "minimum": 0, "example": 0.4 }, "id": { "type": "string", "description": "Filter value id for gender", "enum": [ "MALE", "FEMALE" ] } }, "required": [ "id" ] }, "AgeWeightedFilter": { "type": "object", "properties": { "weight": { "type": "number", "description": "Weight of filter.", "maximum": 1, "minimum": 0, "example": 0.4 }, "id": { "type": "string", "description": "Filter value id for age", "enum": [ "13-17", "18-24", "25-34", "35-44", "45-64", "65-" ] } }, "required": [ "id" ] }, "AudienceAgeRange": { "type": "object", "properties": { "min": { "type": "string", "example": 18, "description": "Minimum audience age.", "enum": [ "13", "18", "25", "35", "45", "65" ] }, "max": { "type": "string", "example": 24, "description": "Maximum audience age.", "enum": [ "17", "24", "34", "44", "64" ] }, "weight": { "type": "number", "description": "Weight of audience age range.", "minimum": 0, "maximum": 1, "example": 0.3 } } }, "InterestsWeightedFilter": { "type": "object", "properties": { "weight": { "type": "number", "description": "Weight of filter.", "maximum": 1, "minimum": 0, "example": 0.4 }, "id": { "type": "number", "description": "Filter value id for interests (e.g. 1708)" } }, "required": [ "id" ] }, "InstagramSearchAudienceFilters": { "type": "object", "properties": { "location": { "example": [ { "id": 148838, "weight": 0.2 }, { "id": 62149, "weight": 0.2 }, { "id": 80500, "weight": 0.2 }, { "id": 1428125, "weight": 0.2 }, { "id": 304716, "weight": 0.2 } ], "description": "Filter by Audience Location, You can get the locations with our locations api end point and send location ids in an array together with their weight percentages. The default percentage is set to 20% (0.2)", "type": "array", "items": { "$ref": "#/components/schemas/LocationWeightedFilter" } }, "language": { "example": { "id": "en", "weight": 0.2 }, "description": "Filter by Audience Language, You can get the languages code with our languages api end point and send the location id within an object, together with the weight percentage. The default percentage is set to 20% (0.2)", "allOf": [ { "$ref": "#/components/schemas/LanguageWeightedFilter" } ] }, "gender": { "example": { "id": "MALE", "weight": 0.5 }, "description": "Filter by gender specific Audience, You can send the gender together with the weight percentage. The default percentage is set to 50% (0.5)", "allOf": [ { "$ref": "#/components/schemas/GenderWeightedFilter" } ] }, "age": { "example": [ { "id": "18-24", "weight": 0.3 }, { "id": "65-", "weight": 0.3 } ], "description": "Filter by Audience age. You can send the age together with the weight percentage. The default percentage is set to 30% (0.3)", "type": "array", "items": { "$ref": "#/components/schemas/AgeWeightedFilter" } }, "ageRange": { "example": { "min": "18", "max": "24", "weight": 0.3 }, "description": "Filter by audience age range. You can send the age range together with the weight percentage. The default percentage is set to 30% (0.3). You can't send both age and ageRange together.", "allOf": [ { "$ref": "#/components/schemas/AudienceAgeRange" } ] }, "interests": { "example": [ { "id": 1708, "weight": 0.2 }, { "id": 13, "weight": 0.2 }, { "id": 3, "weight": 0.2 }, { "id": 21, "weight": 0.2 }, { "id": 1, "weight": 0.2 }, { "id": 11, "weight": 0.2 }, { "id": 7, "weight": 0.2 }, { "id": 1826, "weight": 0.2 } ], "description": "Filter by Audience Interests, You can get the array of interests with our interests api end point and send interests ids in an array together with their weight percentages. The default percentage is set to 30% (0.3)", "type": "array", "items": { "$ref": "#/components/schemas/InterestsWeightedFilter" } }, "credibility": { "type": "number", "example": 0.75, "description": "Filter by Audience Credibility. The value is the inverse of fake followers, meaning 25% fake followers would translate to 0.75 of audience credibility.", "minimum": 0, "maximum": 1 } } }, "InstagramSearchFilters": { "type": "object", "properties": { "influencer": { "$ref": "#/components/schemas/InstagramSearchInfluencerFilters" }, "audience": { "$ref": "#/components/schemas/InstagramSearchAudienceFilters" } } }, "InstagramSearchBody": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "default": 0, "minimum": 0, "maximum": 665 }, "calculationMethod": { "type": "string", "example": "median", "default": "median", "description": "If specified, this indicates the method used to compute average-based metrics, such as average number of likes, comments, shares, etc.", "enum": [ "median", "average" ] }, "sort": { "description": "Sorting", "allOf": [ { "$ref": "#/components/schemas/InstagramSort" } ] }, "filter": { "example": { "influencer": { "followers": { "min": 20000 }, "engagementRate": 0.02, "location": [ 148838, 62149, 80500, 1428125, 304716 ], "language": "en", "lastposted": 90, "gender": "MALE", "age": { "min": 18 }, "followersGrowthRate": { "interval": "i6months", "value": 0.01, "operator": "gt" }, "hasContactDetails": [ { "contactType": "email", "filterAction": "must" } ], "interests": [ 3, 21, 1, 13, 11, 1708, 7, 1826 ], "keywords": "supercars", "reelsPlays": { "min": 20000 }, "engagements": { "min": 5000 } }, "audience": { "location": [ { "id": 148838, "weight": 0.2 }, { "id": 62149, "weight": 0.2 }, { "id": 80500, "weight": 0.2 }, { "id": 1428125, "weight": 0.2 }, { "id": 304716, "weight": 0.2 } ], "language": { "id": "en", "weight": 0.2 }, "gender": { "id": "MALE", "weight": 0.5 }, "age": [ { "id": "18-24", "weight": 0.3 }, { "id": "65-", "weight": 0.3 } ], "interests": [ { "id": 1708, "weight": 0.2 }, { "id": 13, "weight": 0.2 }, { "id": 3, "weight": 0.2 }, { "id": 21, "weight": 0.2 }, { "id": 1, "weight": 0.2 }, { "id": 11, "weight": 0.2 }, { "id": 7, "weight": 0.2 }, { "id": 1826, "weight": 0.2 } ], "credibility": 0.75 } }, "allOf": [ { "$ref": "#/components/schemas/InstagramSearchFilters" } ] } } }, "ProfileResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id of the influencer", "example": "173560420" }, "fullname": { "type": "string", "description": "Full name of Influencer", "example": "Instagram" }, "username": { "type": "string", "description": "Username of Influencer", "example": "instagram" }, "url": { "type": "string", "description": "Profile URL", "example": "https://www.instagram.com/instagram/" }, "picture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followers": { "type": "number", "description": "Follower count", "example": 313560626 }, "engagements": { "type": "number", "description": "Engagements", "example": 857994 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.0027362938100525414 } }, "required": [ "username", "url", "picture", "followers", "engagements", "engagementRate" ] }, "InfluencerMatch": { "type": "object", "properties": { "geo": { "type": "object", "description": "Influencer geo", "example": { "city": { "id": 1, "name": "New York", "code": "NY" }, "state": { "id": 1, "name": "California", "code": "CA" }, "country": { "id": 1, "name": "United States", "code": "US" }, "subdivision": { "id": 1, "name": "New York State", "code": "NY" } } }, "language": { "type": "object", "description": "Influencer language", "example": { "code": "en", "name": "English" } }, "relevance": { "type": "number", "description": "Influencer relevance", "example": 0.85 }, "gender": { "type": "string", "description": "Influencer gender", "example": "FEMALE" }, "age": { "type": "string", "description": "Influencer age", "example": "25-34" }, "followersGrowthRate": { "type": "number", "description": "Influencer followers growth rate", "example": 0.05 }, "brands": { "description": "Influencer brands", "example": [ { "id": 1, "name": "Nike" } ], "type": "array", "items": { "type": "object" } }, "interests": { "description": "Influencer interests", "example": [ { "id": 3, "name": "Music" } ], "type": "array", "items": { "type": "object" } }, "audienceRelevance": { "type": "number", "description": "Influencer audience relevance", "example": 0.85 } } }, "AudienceMatch": { "type": "object", "properties": { "ages": { "description": "Audience ages", "example": [ { "code": "13-17", "weight": 0.25 } ], "type": "array", "items": { "type": "object" } }, "ageRange": { "type": "object", "description": "Audience age range", "example": { "code": "13-17", "weight": 0.25 } }, "credibility": { "type": "number", "description": "Audience credibility", "example": 0.85 }, "geo": { "type": "object", "description": "Audience geo", "example": { "countries": [ { "id": 1, "name": "United States", "code": "US", "weight": 0.25 } ], "states": [ { "id": 1, "name": "California", "code": "CA", "weight": 0.25 } ], "cities": [ { "id": 1, "name": "New York", "code": "NY", "weight": 0.25 } ], "subdivisions": [ { "id": 1, "name": "New York State", "weight": 0.25 } ] } }, "interests": { "description": "Audience interests", "example": [ { "id": 1, "name": "Fashion" } ], "type": "array", "items": { "type": "object" } }, "languages": { "description": "Audience languages", "example": [ { "code": "en", "name": "English", "weight": 0.25 } ], "type": "array", "items": { "type": "object" } }, "genders": { "description": "Audience genders", "example": [ { "code": "MALE", "weight": 0.25 } ], "type": "array", "items": { "type": "object" } } } }, "Match": { "type": "object", "properties": { "influencer": { "description": "Influencer match", "allOf": [ { "$ref": "#/components/schemas/InfluencerMatch" } ] }, "audience": { "description": "Audience match", "allOf": [ { "$ref": "#/components/schemas/AudienceMatch" } ] } } }, "InfluencerResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "User Id", "example": "173560420" }, "profile": { "description": "Profile info of influencer", "allOf": [ { "$ref": "#/components/schemas/ProfileResponse" } ] }, "match": { "description": "Match", "allOf": [ { "$ref": "#/components/schemas/Match" } ] } }, "required": [ "userId", "profile" ] }, "SearchResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Number of results", "example": 2 }, "lookalikes": { "description": "Lookalikes", "type": "array", "items": { "$ref": "#/components/schemas/InfluencerResponse" } }, "directs": { "description": "Directs", "type": "array", "items": { "$ref": "#/components/schemas/InfluencerResponse" } }, "isExactMatch": { "type": "boolean", "description": "Are the results exactly matching the filters you provided? If we don't find exact results then we try to show similar users by automatically removing some filters for you.", "example": true } }, "required": [ "total", "lookalikes", "directs", "isExactMatch" ] }, "InstagramProfileResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id of the influencer", "example": "173560420" }, "fullname": { "type": "string", "description": "Full name of Influencer", "example": "Instagram" }, "username": { "type": "string", "description": "Username of Influencer", "example": "instagram" }, "url": { "type": "string", "description": "Profile URL", "example": "https://www.instagram.com/instagram/" }, "picture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followers": { "type": "number", "description": "Follower count", "example": 313560626 }, "engagements": { "type": "number", "description": "Engagements", "example": 857994 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.0027362938100525414 } }, "required": [ "username", "url", "picture", "followers", "engagements", "engagementRate" ] }, "Tag": { "type": "object", "properties": { "tag": { "type": "string", "example": "" }, "weight": { "type": "number", "example": 0.1 } }, "required": [ "tag", "weight" ] }, "ContentTypeStatsHistory": { "type": "object", "properties": { "month": { "type": "string", "example": "2025-01" }, "avgLikes": { "type": "number", "example": 0 }, "avgEngagements": { "type": "number", "example": 0 }, "avgViews": { "type": "number", "example": 0 }, "avgComments": { "type": "number", "example": 0 }, "avgShares": { "type": "number", "example": 0 }, "avgSaves": { "type": "number", "example": 0 } } }, "ContentTypeStatsInstagram": { "type": "object", "properties": { "engagements": { "type": "number", "example": 0 }, "engagementRate": { "type": "number", "example": 0 }, "avgLikes": { "type": "number", "example": 0 }, "avgComments": { "type": "number", "example": 0 }, "statHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeStatsHistory" } }, "avgReelsPlays": { "type": "number", "example": 0 }, "avgShares": { "type": "number", "example": 0 } } }, "StatsByContentTypeInstagram": { "type": "object", "properties": { "all": { "example": {}, "description": "All content type stats", "allOf": [ { "$ref": "#/components/schemas/ContentTypeStatsInstagram" } ] }, "reels": { "example": {}, "description": "Reels stats", "allOf": [ { "$ref": "#/components/schemas/ContentTypeStatsInstagram" } ] } } }, "WeightWithCode": { "type": "object", "properties": { "code": { "type": "string", "example": "" }, "weight": { "type": "number", "example": 0.07 } }, "required": [ "code", "weight" ] }, "WeightWithCodeName": { "type": "object", "properties": { "name": { "type": "string", "example": "" }, "weight": { "type": "number", "example": 0.07 }, "code": { "type": "string", "example": "" } }, "required": [ "name", "weight", "code" ] }, "GenderPerAge": { "type": "object", "properties": { "code": { "type": "string", "example": "" }, "male": { "type": "number", "example": 0.07 }, "female": { "type": "number", "example": 0.07 } }, "required": [ "code", "male", "female" ] }, "WeightWithName": { "type": "object", "properties": { "name": { "type": "string", "example": "" }, "weight": { "type": "number", "example": 0.07 } }, "required": [ "name", "weight" ] }, "InstagramAudienceSubdivision": { "type": "object", "properties": { "name": { "type": "string", "example": "" }, "code": { "type": "string", "example": "" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithName" } } }, "required": [ "name", "code", "items" ] }, "AudienceLanguage": { "type": "object", "properties": { "code": { "type": "string", "example": "it" }, "name": { "type": "string", "example": "Italian" }, "weight": { "type": "number", "example": 0.1 } }, "required": [ "code", "name", "weight" ] }, "User": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id of the influencer", "example": "173560420" }, "fullname": { "type": "string", "description": "Full name of Influencer", "example": "Instagram" }, "username": { "type": "string", "description": "Username of Influencer", "example": "instagram" }, "url": { "type": "string", "description": "Profile URL", "example": "https://www.instagram.com/instagram/" }, "picture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followers": { "type": "number", "description": "Follower count", "example": 313560626 }, "engagements": { "type": "number", "description": "Engagements", "example": 857994 } }, "required": [ "username", "url", "picture", "followers", "engagements" ] }, "AudienceEthnicities": { "type": "object", "properties": { "code": { "type": "string", "example": "white", "enum": [ "white", "asian", "african_american", "hispanic" ] }, "name": { "type": "string", "example": "White / Caucasian", "enum": [ "White / Caucasian", "Asian", "African American", "Hispanic" ] }, "weight": { "type": "number", "example": 0.1 } }, "required": [ "code", "name", "weight" ] }, "AudienceReachability": { "type": "object", "properties": { "code": { "type": "string", "example": "500-1000", "enum": [ "-500", "500-1000", "1000-1500", "1500-" ], "description": "Range of the number of accounts followed" }, "weight": { "type": "number", "example": 0.1, "description": "Percentage of the audience" } }, "required": [ "code", "weight" ] }, "AudienceType": { "type": "object", "properties": { "code": { "type": "string", "example": "real", "enum": [ "mass_followers", "suspicious", "influencers", "real" ], "description": "Type of the audience" }, "weight": { "type": "number", "example": 0.9, "description": "Percentage of the audience" } }, "required": [ "code", "weight" ] }, "InstagramReportAudience": { "type": "object", "properties": { "notable": { "type": "number", "example": 0.07 }, "genders": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCode" } }, "geoCountries": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCodeName" } }, "ages": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCode" } }, "gendersPerAge": { "type": "array", "items": { "$ref": "#/components/schemas/GenderPerAge" } }, "geoCities": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithName" } }, "geoStates": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithName" } }, "geoSubdivisions": { "type": "array", "items": { "$ref": "#/components/schemas/InstagramAudienceSubdivision" } }, "credibility": { "type": "number", "example": 0.75 }, "interests": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithName" } }, "brandAffinity": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithName" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/AudienceLanguage" } }, "notableUsers": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "audienceLookalikes": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "ethnicities": { "type": "array", "items": { "$ref": "#/components/schemas/AudienceEthnicities" } }, "audienceReachability": { "description": "Percentage of the audience based on the number of accounts they follow, categorized into specific ranges. For instance, percentage of followers following no more than 500 accounts, or following between 500 and 1000 accounts.", "example": [ { "code": "-500", "weight": 0.379536 }, { "code": "500-1000", "weight": 0.161691 }, { "code": "1000-1500", "weight": 0.097547 }, { "code": "1500-", "weight": 0.361225 } ], "type": "array", "items": { "$ref": "#/components/schemas/AudienceReachability" } }, "audienceTypes": { "description": "Percentage of the audience based on the type of accounts they follow", "example": [ { "code": "mass_followers", "weight": 0.379536 }, { "code": "suspicious", "weight": 0.161691 }, { "code": "influencers", "weight": 0.097547 }, { "code": "real", "weight": 0.361225 } ], "type": "array", "items": { "$ref": "#/components/schemas/AudienceType" } } }, "required": [ "notable", "genders", "geoCountries", "ages", "gendersPerAge", "geoCities", "geoStates", "geoSubdivisions", "credibility", "interests", "brandAffinity", "languages", "notableUsers", "audienceLookalikes", "ethnicities" ] }, "StatsData": { "type": "object", "properties": { "value": { "type": "number", "description": "Value", "example": 859004 }, "compared": { "type": "number", "description": "Change in value compared to last month", "example": 0.007144320631801482 } } }, "Stats": { "type": "object", "properties": { "avgLikes": { "description": "Average Likes and historical comparison", "allOf": [ { "$ref": "#/components/schemas/StatsData" } ] }, "followers": { "description": "Followers and historical comparison", "allOf": [ { "$ref": "#/components/schemas/StatsData" } ] }, "avgShares": { "description": "Average Shares and historical comparison", "allOf": [ { "$ref": "#/components/schemas/StatsData" } ] }, "avgComments": { "description": "Average Comments and historical comparison", "allOf": [ { "$ref": "#/components/schemas/StatsData" } ] } } }, "InstagramRecentPost": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" }, "created": { "type": "string" }, "likes": { "type": "number" }, "comments": { "type": "number" }, "views": { "type": "number" }, "type": { "type": "string" }, "mentions": { "type": "array", "items": { "type": "string" } }, "hashtags": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "text", "url", "created", "type" ] }, "InstagramPopularPost": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" }, "created": { "type": "string" }, "likes": { "type": "number" }, "comments": { "type": "number" }, "views": { "type": "number" }, "type": { "type": "string" }, "thumbnail": { "type": "string" } }, "required": [ "id", "text", "url", "created", "type", "thumbnail" ] }, "Language": { "type": "object", "properties": { "code": { "type": "string", "example": "en", "enum": [ "af", "als", "am", "an", "ar", "arz", "as", "ast", "av", "az", "azb", "ba", "bar", "bcl", "be", "bg", "bh", "bn", "bo", "bpy", "br", "bs", "bxr", "ca", "cbk", "ce", "ceb", "ckb", "co", "cs", "cv", "cy", "da", "de", "diq", "dsb", "dty", "dv", "dz", "el", "eml", "en", "eo", "es", "et", "eu", "fa", "fi", "fo", "fr", "frr", "fy", "ga", "gd", "gl", "gn", "gom", "gu", "gv", "he", "hi", "hif", "hr", "hsb", "ht", "hu", "hy", "ia", "id", "ie", "ilo", "io", "is", "it", "ja", "jbo", "jv", "ka", "kk", "km", "kn", "ko", "krc", "ku", "kv", "kw", "ky", "la", "lb", "lez", "li", "lmo", "lo", "lrc", "lt", "lv", "mai", "mg", "mhr", "min", "mk", "ml", "mn", "mr", "mrj", "ms", "mt", "mwl", "my", "myv", "mzn", "nah", "nap", "nb", "nds", "ne", "new", "nl", "nn", "no", "oc", "or", "os", "pa", "pam", "pfl", "pl", "pms", "pnb", "ps", "pt", "qu", "rm", "ro", "ru", "rue", "rw", "sa", "sah", "sc", "scn", "sco", "sd", "se", "sh", "si", "sk", "sl", "so", "sq", "sr", "su", "sv", "sw", "ta", "te", "tg", "th", "tk", "tl", "tr", "tt", "tyv", "ug", "uk", "ur", "uz", "vec", "vep", "vi", "vls", "vo", "wa", "war", "wuu", "xal", "xh", "xmf", "yi", "yo", "yue", "zh", "zu" ] }, "name": { "type": "string", "example": "English" } }, "required": [ "code", "name" ] }, "Contacts": { "type": "object", "properties": { "type": { "type": "string", "example": "email", "enum": [ "bbm", "email", "facebook", "instagram", "itunes", "kakao", "kik", "lineid", "linktree", "phone", "pinterest", "sarahah", "sayat", "skype", "snapchat", "telegram", "threads", "tiktok", "tumblr", "twitchtv", "twitter", "viber", "vk", "wechat", "weibo", "whatsapp", "youtube" ] }, "value": { "type": "string", "example": "influenceremail@example.com", "minLength": 1 } }, "required": [ "type", "value" ] }, "Interest": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "" } }, "required": [ "id", "name" ] }, "Brand": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "" } }, "required": [ "id", "name" ] }, "PostSponsor": { "type": "object", "properties": { "domain": { "type": "string" }, "logo_url": { "type": "string" }, "name": { "type": "string" } } }, "InstagramSponsoredPost": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" }, "created": { "type": "string" }, "likes": { "type": "number" }, "comments": { "type": "number" }, "views": { "type": "number" }, "type": { "type": "string" }, "mentions": { "type": "array", "items": { "type": "string" } }, "hashtags": { "type": "array", "items": { "type": "string" } }, "video": { "type": "string" }, "image": { "type": "string" }, "thumbnail": { "type": "string" }, "sponsors": { "type": "array", "items": { "$ref": "#/components/schemas/PostSponsor" } } }, "required": [ "id", "text", "url", "created", "type", "thumbnail" ] }, "MonthlyStat": { "type": "object", "properties": { "month": { "type": "string", "example": "2019-05" }, "followers": { "type": "number", "example": 1000 }, "following": { "type": "number", "example": 1000 }, "avgLikes": { "type": "number", "example": 1000 }, "avgViews": { "type": "number", "example": 1000 }, "avgComments": { "type": "number", "example": 1000 }, "avgShares": { "type": "number", "example": 1000 } }, "required": [ "month", "followers", "following", "avgLikes", "avgViews", "avgComments" ] }, "FollowersRange": { "type": "object", "properties": { "leftNumber": { "type": "number", "example": 100000 }, "rightNumber": { "type": "number", "example": 500000 } } }, "HistogramBin": { "type": "object", "properties": { "min": { "type": "number", "description": "The lower bound of the range", "example": 0.4546 }, "max": { "type": "number", "description": "The upper bound of the range", "example": 0.6482 }, "total": { "type": "number", "description": "The total count of data points within this range", "example": 5551 }, "median": { "type": "boolean", "description": "Indicates if this bin represents the median range of the data. Only one range has this value set to `true`", "example": true } }, "required": [ "total" ] }, "AudienceExtraInstagramReportData": { "type": "object", "properties": { "followersRange": { "description": "All histograms shown here are based on influencers whose number of followers fall within the range specified in this field", "allOf": [ { "$ref": "#/components/schemas/FollowersRange" } ] }, "engagementRateDistribution": { "description": "Distribution of influencers by their followers' engagement rate. This histogram displays how influencers from the same follower group are distributed based on the engagement rate of their followers. Ranges are automatically chosen for a clearer view of the entire histogram", "type": "array", "items": { "$ref": "#/components/schemas/HistogramBin" } }, "credibilityDistribution": { "description": "Distribution of influencers by their followers' credibility. This histogram displays how influencers from the same follower group are distributed based on the credibility of their followers. Ranges are automatically chosen for a clearer view of the entire histogram", "type": "array", "items": { "$ref": "#/components/schemas/HistogramBin" } } }, "required": [ "followersRange", "engagementRateDistribution" ] }, "InstagramReportProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User Id", "example": "173560420" }, "profile": { "description": "Influencer Profile", "allOf": [ { "$ref": "#/components/schemas/InstagramProfileResponse" } ] }, "hashtags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "mentions": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "statsByContentType": { "description": "User stats separated by content type", "allOf": [ { "$ref": "#/components/schemas/StatsByContentTypeInstagram" } ] }, "audience": { "description": "Audience data", "allOf": [ { "$ref": "#/components/schemas/InstagramReportAudience" } ] }, "stats": { "description": "Influencer stats, likes and followers (deprecated in favor of statsByContentType)", "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/Stats" } ] }, "recentPosts": { "description": "Recent Posts", "example": [ { "id": "string", "text": "string", "url": "string", "created": "string", "likes": 0, "comments": 0, "mentions": [ "string" ], "hashtags": [ "string" ] } ], "type": "array", "items": { "$ref": "#/components/schemas/InstagramRecentPost" } }, "popularPosts": { "description": "Popular Posts", "type": "array", "items": { "$ref": "#/components/schemas/InstagramPopularPost" } }, "city": { "type": "string", "example": "New york" }, "state": { "type": "string", "example": "California" }, "subdivision": { "type": "string", "example": "New York State" }, "gender": { "type": "string", "example": "FEMALE", "enum": [ "MALE", "FEMALE" ] }, "language": { "$ref": "#/components/schemas/Language" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contacts" } }, "country": { "type": "string", "example": "US" }, "ageGroup": { "type": "string", "example": "18-24", "enum": [ "13-17", "18-24", "25-34", "35-44", "45-64", "65-" ] }, "isPrivate": { "type": "boolean", "example": true }, "accountType": { "type": "string", "example": "Regular", "enum": [ "Regular", "Business", "Creator" ] }, "isVerified": { "type": "boolean", "example": true }, "postsCounts": { "type": "number", "example": 37 }, "avgLikes": { "type": "number", "example": 18211 }, "avgComments": { "type": "number", "example": 12321 }, "bio": { "type": "string", "example": "CEO of #RockTok" }, "interests": { "type": "array", "items": { "$ref": "#/components/schemas/Interest" } }, "brandAffinity": { "type": "array", "items": { "$ref": "#/components/schemas/Brand" } }, "sponsoredPosts": { "type": "array", "items": { "$ref": "#/components/schemas/InstagramSponsoredPost" } }, "statHistory": { "type": "array", "items": { "$ref": "#/components/schemas/MonthlyStat" } }, "lookalikes": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "postsCount": { "type": "number", "example": 37 }, "avgViews": { "type": "number", "example": 48 }, "avgReelsPlays": { "type": "number", "example": 5727 }, "audienceExtra": { "$ref": "#/components/schemas/AudienceExtraInstagramReportData" }, "paidPostPerformance": { "type": "number", "example": 0.5 }, "paidPostPerformanceViews": { "type": "number", "example": 37 }, "sponsoredPostsMedianViews": { "type": "number", "example": 3127 }, "sponsoredPostsMedianLikes": { "type": "number", "example": 3743 }, "nonSponsoredPostsMedianViews": { "type": "number", "example": 267 }, "nonSponsoredPostsMedianLikes": { "type": "number", "example": 367 } }, "required": [ "userId", "hashtags", "mentions", "isPrivate", "accountType", "isVerified", "postsCounts", "avgLikes", "avgComments", "bio", "interests", "brandAffinity", "sponsoredPosts", "statHistory", "lookalikes", "postsCount", "avgViews", "avgReelsPlays", "paidPostPerformanceViews", "sponsoredPostsMedianViews", "sponsoredPostsMedianLikes", "nonSponsoredPostsMedianViews", "nonSponsoredPostsMedianLikes" ] }, "InstagramReport": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "profile": { "$ref": "#/components/schemas/InstagramReportProfile" } }, "required": [ "profile" ] }, "CollaborationsPostStats": { "type": "object", "properties": { "likes": { "type": "number", "description": "Likes", "example": 123 }, "comments": { "type": "number", "description": "Comments", "example": 12 }, "likes_and_views_counts_enabled": { "type": "boolean", "description": "Likes and views counts enabled", "example": true }, "likes_count_enabled": { "type": "boolean", "description": "Likes count enabled", "example": true }, "plays": { "type": "number", "description": "Plays", "example": 123 }, "views": { "type": "number", "description": "Views", "example": 123 }, "shares": { "type": "number", "description": "Shares", "example": 123 }, "views_count_enabled": { "type": "boolean", "description": "Views count enabled", "example": true } } }, "CollaborationsSponsor": { "type": "object", "properties": { "name": { "type": "string", "description": "Brand name", "example": "Honda" }, "username": { "type": "string", "description": "Brand username", "example": "honda" }, "domain": { "type": "string", "description": "Brand domain", "example": "honda.com" }, "logo_url": { "type": "string", "description": "Brand logo", "example": "https://images.od.modash.io/739b39affeb633d30a8a4280668605b091af0083" }, "user_id": { "type": "string", "description": "Brand ID", "example": "1234567890" }, "category": { "type": "string", "description": "Brand category (if multiple categories are relevant, we return the most relevant one)", "enum": [ "Consumer Packaged Goods (CPG)", "Retail", "B2B/Enterprise/Industrial", "Classifieds & Local", "Food Beverage Restaurants", "Healthcare", "Media & Entertainment", "Technology", "Education", "Finance", "Automotive", "Travel", "Others", "Unknown" ], "example": "Travel" } }, "required": [ "category" ] }, "CollaborationsPostInfluencerPaginated": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Post id", "example": "4333460164" }, "post_thumbnail": { "type": "string", "description": "Post thumbnail", "example": "https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f" }, "post_timestamp": { "type": "number", "description": "Post timestamp", "example": 1729502216000 }, "title": { "type": "string", "description": "Title", "example": "Title" }, "description": { "type": "string", "description": "Description", "example": "Description" }, "label": { "type": "string", "description": "Sponsorship category followed by the evidence. Possible categories: \t\t\t(1) Properly Disclosed Sponsorship - uses #ad, paid partnership flag, or explicitly indicates a partnership in text (e.g., \"I teamed up with X to...\"). \t\t\t(2) Likely Hidden Sponsorship - no clear disclosures, but other signals indicate a sponsorship (e.g., \"Use [CODE] for X% off\" or \"thanks @brand\"). \t\t\t(3) Unclear or Vague Sponsorship Hint - a mention/tag of a known sponsor, but without proper disclosures.", "example": "Properly Disclosed Sponsorship: is paid partnership flag" }, "collaboration_type": { "type": "string", "description": "Type of collaboration (if multiple types are relevant, we return the most relevant one)", "enum": [ "Paid", "Gifted", "Ambassador", "Affiliate", "Unspecified" ], "example": "Paid" }, "stats": { "description": "Stats", "allOf": [ { "$ref": "#/components/schemas/CollaborationsPostStats" } ] }, "sponsors": { "description": "Sponsors", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationsSponsor" } }, "user_id": { "type": "string", "description": "User id", "example": "173560420" }, "username": { "type": "string", "description": "Username", "example": "username" }, "user_picture": { "type": "string", "description": "User picture", "example": "https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f" }, "platform": { "type": "string", "description": "Platform", "example": "instagram" } }, "required": [ "post_id", "label", "collaboration_type" ] }, "CollaborationsInfluencerResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "collaborations": { "description": "Collaborations", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationsPostInfluencerPaginated" } }, "more_available": { "type": "boolean" }, "end_cursor": { "type": "string" } } }, "AudiencerOverlapBody": { "type": "object", "properties": { "influencers": { "description": "List of usernames or user ids", "example": [ "MrBeast", "cristiano" ], "type": "array", "items": { "type": "string" } } } }, "ReportInfo": { "type": "object", "properties": { "totalFollowers": { "type": "number", "description": "Total followers" }, "totalUniqueFollowers": { "type": "number", "description": "Total unique followers" } }, "required": [ "totalFollowers", "totalUniqueFollowers" ] }, "OverlapReport": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1 }, "username": { "type": "string", "minLength": 1 }, "followers": { "type": "number", "description": "Number of followers for this influencer" }, "uniquePercentage": { "type": "number", "description": "The percent of followers that are unique for this influencer (they do not follow any other influencer within this overlap request)" }, "overlappingPercentage": { "type": "number", "description": "The percent of followers that overlap with at least one other influencer (they follow at least one other influencer within this overlap request)" } }, "required": [ "userId", "followers", "uniquePercentage", "overlappingPercentage" ] }, "AudienceOverlapResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "reportInfo": { "$ref": "#/components/schemas/ReportInfo" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OverlapReport" } } }, "required": [ "reportInfo", "data" ] }, "ListBrandsResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "brands": { "type": "array", "items": { "$ref": "#/components/schemas/Brand" } }, "total": { "type": "number", "example": 28, "description": "Total number of brands" } }, "required": [ "brands", "total" ] }, "ListInterestsResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "interests": { "type": "array", "items": { "$ref": "#/components/schemas/Interest" } }, "total": { "type": "number", "example": 28, "description": "Total number of interests" } }, "required": [ "interests", "total" ] }, "HashtagsResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "tags" ] }, "ListLanguagesResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "total": { "type": "number", "example": 98, "description": "Total number of languages" } }, "required": [ "languages", "total" ] }, "Location": { "type": "object", "properties": { "id": { "type": "number", "example": 51800, "description": "Id of the location" }, "name": { "type": "string", "example": "London", "description": "Name of the location" }, "title": { "type": "string", "example": "London, United Kingdom", "description": "Full title of the location" } }, "required": [ "id", "name", "title" ] }, "ListLocationsResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } }, "total": { "type": "number", "example": 8477, "description": "Total number of locations" } }, "required": [ "locations", "total" ] }, "UserInfluencer": { "type": "object", "properties": { "userId": { "type": "string", "example": "232192182", "description": "User Id" }, "username": { "type": "string", "example": "therock", "description": "Username" }, "fullname": { "type": "string", "example": "therock", "description": "User's full name" }, "picture": { "type": "string", "example": "https://imgigp.modash.io/v2?mb0KwpL92uYofJiSjDn1%2F6peL1lBwv3s%2BUvShHERlDbrEEwrWumIvR20xZeZXa0LDeIrcniqZeG9S%2F1a5s2Rx3FZdXrWpY%2BmSBJp1l%2FmBGon3rcHA4EfuatZqMhVBzAT", "description": "User's profile image URL" }, "followers": { "type": "number", "example": 313583625, "description": "User's number of followers" }, "isVerified": { "type": "boolean", "example": true, "description": "User has verified badge" } }, "required": [ "userId", "username", "fullname", "picture", "followers", "isVerified" ] }, "ListUsersResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserInfluencer" } } }, "required": [ "users" ] }, "TikTokSort": { "type": "object", "properties": { "field": { "type": "string", "example": "followers", "default": "followers", "description": "Note: The following sort options are available only when the corresponding filter is applied: `keywords` `audienceGeo` `audienceLang` `audienceGender` `audienceAge` `followersGrowth` `likesGrowth`.
\n\t\tSorting field in which order you want to get the results.", "enum": [ "engagements", "followers", "engagementRate", "keywords", "audienceGeo", "audienceLang", "audienceGender", "audienceAge", "audienceRelevance", "relevance", "followersGrowth", "views", "shares", "saves", "likesGrowth" ] }, "value": { "type": "number", "example": 123, "description": "Only required for ```audienceGeo``` sorting." }, "direction": { "type": "string", "example": "desc", "default": "desc", "description": "Sorting direction", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] }, "ViewsCount": { "type": "object", "properties": { "min": { "type": "number", "example": 5000, "description": "Minimum views count." }, "max": { "type": "number", "example": 10000, "description": "Maximum views count." } } }, "SharesCount": { "type": "object", "properties": { "min": { "type": "number", "example": 5000, "description": "Minimum shares count (this value will be rounded)." }, "max": { "type": "number", "example": 10000, "description": "Maximum shares count (this value will be rounded)." } } }, "SavesCount": { "type": "object", "properties": { "min": { "type": "number", "example": 5000, "description": "Minimum saves count (this value will be rounded)." }, "max": { "type": "number", "example": 10000, "description": "Maximum saves count (this value will be rounded)." } } }, "TikTokFilterOperations": { "type": "object", "properties": { "operator": { "type": "string", "description": "Logical operations used to combine filters.
Note: To use the `or` operator, you must apply it to at least two filters.", "enum": [ "and", "or", "not" ] }, "filter": { "type": "string", "description": "Filter to apply the operation on. If `keywords` or `relevance` are specified then you can not sort by these fields.", "enum": [ "followers", "engagements", "engagementRate", "lastposted", "bio", "keywords", "relevance", "language", "gender", "age", "location", "isVerified", "views", "textTags" ] } }, "required": [ "operator", "filter" ] }, "TikTokSearchInfluencerFilters": { "type": "object", "properties": { "followers": { "example": { "min": 20000, "max": 70000 }, "description": "We round followers value in the filter: whenever it's below 5k, we round it to the nearest thousand (4123 -> 4000; 4800-> 5000); when it's over 5k, we round it to the nearest 5,000 (27k -> 25k; 28k -> 30k).", "allOf": [ { "$ref": "#/components/schemas/FollowersCount" } ] }, "engagementRate": { "type": "number", "description": "Minimum engagement rate.", "maximum": 1, "minimum": 0, "example": 0.02 }, "location": { "example": [ 148838, 62149, 80500, 1428125, 304716 ], "description": "Filter by Influencer Location, You can get the locations with our locations api end point and send location ids in an array.", "maxItems": 20, "type": "array", "items": { "type": "number" } }, "language": { "type": "string", "example": "en", "description": "Filter by Influencer Language, You can get the languages code with our languages api end point.", "minLength": 1, "maxLength": 3 }, "lastposted": { "type": "number", "example": 90, "description": "Idenitfy influencers based on when they last posted. The number represents days and should be >= 30.", "minimum": 30 }, "relevance": { "example": [ "#cars", "@topgear" ], "description": "Filter by topic of influencers posts or by similarity of topic to other influencer. For example \"#cars #audi @topgear\" means \"Writing about #cars and #audi, has similar topic as @topgear account.\" You can only enter 100 usernames.", "type": "array", "items": { "type": "string" } }, "audienceRelevance": { "example": [ "@topgear" ], "description": "Filter by similarity of influencer's audience to another influencer's audience. For example \"@topgear\" means \"Has audience similar to @topgear account.\" Audience similarity means followers follow accounts with the same topics as those followed by @topgear's audience.", "type": "array", "items": { "type": "string" } }, "gender": { "type": "string", "example": "MALE", "description": "Filter by Influencer gender.", "enum": [ "MALE", "FEMALE", "KNOWN", "UNKNOWN" ] }, "age": { "description": "Filter by Influencer age, possible values are: 18, 25, 35, 45, 65. You have the option to utilize either the `min` field, the `max` field, or both concurrently. Any number that falls outside the accepted range will be disregarded.", "allOf": [ { "$ref": "#/components/schemas/InfluencerAgeRange" } ] }, "followersGrowthRate": { "description": "Growth rate by followers over a period of time.", "example": { "interval": "i6months", "value": 0.01, "operator": "gt" }, "allOf": [ { "$ref": "#/components/schemas/GrowthFilter" } ] }, "bio": { "type": "string", "example": "photos videos", "description": "Search influencer by their bio description and/or full name" }, "hasAudienceData": { "type": "boolean", "description": "Filter by whether the influencer has audience data available. If true, shows only accounts with audience data. If false, shows all accounts including those without audience data. If not specified, defaults to true." }, "views": { "description": "Filter by views count", "allOf": [ { "$ref": "#/components/schemas/ViewsCount" } ] }, "hasContactDetails": { "description": "If Influencer has contact details.", "type": "array", "items": { "$ref": "#/components/schemas/ContactFilter" } }, "textTags": { "example": [ { "type": "hashtag", "value": "carsofinstagram" }, { "type": "mention", "value": "topgear" } ], "maxItems": 20, "description": "Filter by influencers who have used the defined hashtags or mentions in their posts. ", "type": "array", "items": { "$ref": "#/components/schemas/TextTag" } }, "keywords": { "type": "string", "description": "Identify influencers by a phrase they use within the caption of their post.", "example": "cars" }, "isVerified": { "type": "boolean", "description": "Set to `true` to filter by verified influencers." }, "likesGrowthRate": { "description": "Growth rate by total likes over a period of time.", "example": { "interval": "i1month", "value": 0.2, "operator": "gt" }, "allOf": [ { "$ref": "#/components/schemas/GrowthFilter" } ] }, "shares": { "description": "Filter by shares count", "allOf": [ { "$ref": "#/components/schemas/SharesCount" } ] }, "saves": { "description": "Filter by saves count", "allOf": [ { "$ref": "#/components/schemas/SavesCount" } ] }, "engagements": { "description": "Filter by engagements count", "allOf": [ { "$ref": "#/components/schemas/EngagementsCount" } ] }, "filterOperations": { "description": "Modify filter operation to use `and`, `or`, or `not`. Example: Search for influencer using the keyword *cars* AND `not` from the London or Female `or` interested in Beauty & Cosmetics.
If no operator is specified, the default operator applied is the `and` operator.", "type": "array", "items": { "$ref": "#/components/schemas/TikTokFilterOperations" } } } }, "TikTokSearchAudienceFilters": { "type": "object", "properties": { "location": { "example": [ { "id": 148838, "weight": 0.2 }, { "id": 62149, "weight": 0.2 }, { "id": 80500, "weight": 0.2 }, { "id": 1428125, "weight": 0.2 }, { "id": 304716, "weight": 0.2 } ], "description": "Filter by Audience Location, You can get the locations with our locations api end point and send location ids in an array together with their weight percentages. The default percentage is set to 20% (0.2)", "type": "array", "items": { "$ref": "#/components/schemas/LocationWeightedFilter" } }, "language": { "example": { "id": "en", "weight": 0.2 }, "description": "Filter by Audience Language, You can get the languages code with our languages api end point and send the location id within an object, together with the weight percentage. The default percentage is set to 20% (0.2)", "allOf": [ { "$ref": "#/components/schemas/LanguageWeightedFilter" } ] }, "gender": { "example": { "id": "MALE", "weight": 0.5 }, "description": "Filter by gender specific Audience, You can send the gender together with the weight percentage. The default percentage is set to 50% (0.5)", "allOf": [ { "$ref": "#/components/schemas/GenderWeightedFilter" } ] }, "age": { "example": [ { "id": "18-24", "weight": 0.3 }, { "id": "65-", "weight": 0.3 } ], "description": "Filter by Audience age. You can send the age together with the weight percentage. The default percentage is set to 30% (0.3)", "type": "array", "items": { "$ref": "#/components/schemas/AgeWeightedFilter" } }, "ageRange": { "example": { "min": "18", "max": "24", "weight": 0.3 }, "description": "Filter by audience age range. You can send the age range together with the weight percentage. The default percentage is set to 30% (0.3). You can't send both age and ageRange together.", "allOf": [ { "$ref": "#/components/schemas/AudienceAgeRange" } ] } } }, "TikTokSearchFilters": { "type": "object", "properties": { "influencer": { "$ref": "#/components/schemas/TikTokSearchInfluencerFilters" }, "audience": { "$ref": "#/components/schemas/TikTokSearchAudienceFilters" } } }, "TikTokSearchBody": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "default": 0, "minimum": 0, "maximum": 665 }, "calculationMethod": { "type": "string", "example": "median", "default": "median", "description": "If specified, this indicates the method used to compute average-based metrics, such as average number of likes, comments, shares, etc.", "enum": [ "median", "average" ] }, "sort": { "description": "Sorting", "example": { "field": "followers", "direction": "desc" }, "allOf": [ { "$ref": "#/components/schemas/TikTokSort" } ] }, "filter": { "example": { "influencer": { "followers": { "min": 20000 }, "engagementRate": 0.02, "location": [ 148838, 62149, 80500, 1428125, 304716 ], "language": "en", "lastposted": 90, "gender": "MALE", "followersGrowthRate": { "interval": "i6months", "value": 0.01, "operator": "gt" }, "views": { "min": 5000, "max": 10000 }, "hasContactDetails": [ { "contactType": "email", "filterAction": "must" } ], "likesGrowthRate": { "interval": "i1month", "value": 0.2, "operator": "gt" }, "filterOperations": [ { "operator": "and", "filter": "followers" } ] }, "audience": { "location": [ { "id": 148838, "weight": 0.2 }, { "id": 62149, "weight": 0.2 }, { "id": 80500, "weight": 0.2 }, { "id": 1428125, "weight": 0.2 }, { "id": 304716, "weight": 0.2 } ], "language": { "id": "en", "weight": 0.2 }, "gender": { "id": "MALE", "weight": 0.3 }, "age": [ { "id": "18-24", "weight": 0.3 }, { "id": "65-", "weight": 0.3 } ] } }, "allOf": [ { "$ref": "#/components/schemas/TikTokSearchFilters" } ] } } }, "TiktokProfileResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id of the influencer", "example": "173560420" }, "fullname": { "type": "string", "description": "Full name of Influencer", "example": "Instagram" }, "username": { "type": "string", "description": "Username of Influencer", "example": "instagram" }, "url": { "type": "string", "description": "Profile URL", "example": "https://www.instagram.com/instagram/" }, "picture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followers": { "type": "number", "description": "Follower count", "example": 313560626 }, "engagements": { "type": "number", "description": "Engagements", "example": 857994 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.0027362938100525414 }, "averageViews": { "type": "number", "example": 98124 } }, "required": [ "username", "url", "picture", "followers", "engagements", "engagementRate", "averageViews" ] }, "TikTokReportAudience": { "type": "object", "properties": { "notable": { "type": "number", "example": 0.07 }, "genders": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCode" } }, "geoCountries": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCodeName" } }, "ages": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCode" } }, "gendersPerAge": { "type": "array", "items": { "$ref": "#/components/schemas/GenderPerAge" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/AudienceLanguage" } }, "notableUsers": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "audienceLookalikes": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "audienceReachability": { "description": "Percentage of the audience based on the number of accounts they follow, categorized into specific ranges. For instance, percentage of followers following no more than 500 accounts, or following between 500 and 1000 accounts.", "example": [ { "code": "-500", "weight": 0.379536 }, { "code": "500-1000", "weight": 0.161691 }, { "code": "1000-1500", "weight": 0.097547 }, { "code": "1500-", "weight": 0.361225 } ], "type": "array", "items": { "$ref": "#/components/schemas/AudienceReachability" } } }, "required": [ "notable", "genders", "geoCountries", "ages", "gendersPerAge", "languages", "notableUsers", "audienceLookalikes" ] }, "ContentTypeStatsTiktok": { "type": "object", "properties": { "engagements": { "type": "number", "example": 0 }, "engagementRate": { "type": "number", "example": 0 }, "avgLikes": { "type": "number", "example": 0 }, "avgComments": { "type": "number", "example": 0 }, "statHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeStatsHistory" } }, "avgViews": { "type": "number", "example": 0 }, "avgShares": { "type": "number", "example": 0 }, "avgPosts4weeks": { "type": "number", "example": 0 } } }, "StatsByContentTypeTiktok": { "type": "object", "properties": { "all": { "example": {}, "description": "All content type stats", "allOf": [ { "$ref": "#/components/schemas/ContentTypeStatsTiktok" } ] } } }, "TikTokRecentPost": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" }, "created": { "type": "string" }, "likes": { "type": "number" }, "comments": { "type": "number" }, "views": { "type": "number" }, "type": { "type": "string" }, "video": { "type": "string" }, "thumbnail": { "type": "string", "deprecated": true, "example": "https://p16-amd-va.tiktokcdn.com/obj/tos-useast5-p-0068-tx/ogyxG5KtISdEAzSCEzZL4BA7BIij8pf5dwwBli", "description": "Thumbnail images are sent as TikTok URLs that expire in a few hours and are not accessible in most cases. This field will be removed with the next API version." } }, "required": [ "id", "text", "url", "created", "type", "thumbnail" ] }, "AudienceExtraReportData": { "type": "object", "properties": { "followersRange": { "description": "All histograms shown here are based on influencers whose number of followers fall within the range specified in this field", "allOf": [ { "$ref": "#/components/schemas/FollowersRange" } ] }, "engagementRateDistribution": { "description": "Distribution of influencers by their followers' engagement rate. This histogram displays how influencers from the same follower group are distributed based on the engagement rate of their followers. Ranges are automatically chosen for a clearer view of the entire histogram", "type": "array", "items": { "$ref": "#/components/schemas/HistogramBin" } } }, "required": [ "followersRange", "engagementRateDistribution" ] }, "TiktokSponsoredPost": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" }, "created": { "type": "string" }, "likes": { "type": "number" }, "comments": { "type": "number" }, "views": { "type": "number" }, "type": { "type": "string" }, "video": { "type": "string" }, "thumbnail": { "type": "string" }, "title": { "type": "string" }, "sponsors": { "type": "array", "items": { "$ref": "#/components/schemas/PostSponsor" } } }, "required": [ "id", "text", "url", "created", "type", "thumbnail", "title" ] }, "TikTokReportProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User Id", "example": "173560420" }, "profile": { "description": "Influencer Profile", "allOf": [ { "$ref": "#/components/schemas/TiktokProfileResponse" } ] }, "audience": { "description": "Audience data", "allOf": [ { "$ref": "#/components/schemas/TikTokReportAudience" } ] }, "secUid": { "type": "string" }, "statsByContentType": { "description": "User stats separated by content type", "allOf": [ { "$ref": "#/components/schemas/StatsByContentTypeTiktok" } ] }, "recentPosts": { "description": "Recent Posts", "type": "array", "items": { "$ref": "#/components/schemas/TikTokRecentPost" } }, "popularPosts": { "description": "Popular Posts", "type": "array", "items": { "$ref": "#/components/schemas/TikTokRecentPost" } }, "city": { "type": "string", "example": "New york" }, "state": { "type": "string", "example": "California" }, "gender": { "type": "string", "example": "FEMALE", "enum": [ "MALE", "FEMALE" ] }, "statHistory": { "type": "array", "items": { "$ref": "#/components/schemas/MonthlyStat" } }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contacts" } }, "country": { "type": "string", "example": "US" }, "ageGroup": { "type": "string", "example": "18-24", "enum": [ "18-24", "25-34", "35-44", "45-64", "65-" ] }, "isPrivate": { "type": "boolean", "example": true }, "isVerified": { "type": "boolean", "example": true }, "postsCount": { "type": "number", "example": 37 }, "avgLikes": { "type": "number", "example": 18211 }, "totalLikes": { "type": "number", "example": 182211 }, "avgComments": { "type": "number", "example": 12321 }, "bio": { "type": "string", "example": "CEO of #RockTok" }, "interests": { "type": "array", "items": { "$ref": "#/components/schemas/Interest" } }, "lookalikes": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "audienceExtra": { "$ref": "#/components/schemas/AudienceExtraReportData" }, "sponsoredPosts": { "type": "array", "items": { "$ref": "#/components/schemas/TiktokSponsoredPost" } }, "paidPostPerformance": { "type": "number", "example": 0.5 }, "paidPostPerformanceViews": { "type": "number", "example": 37 }, "sponsoredPostsMedianViews": { "type": "number", "example": 3127 }, "sponsoredPostsMedianLikes": { "type": "number", "example": 3743 }, "nonSponsoredPostsMedianViews": { "type": "number", "example": 267 }, "nonSponsoredPostsMedianLikes": { "type": "number", "example": 367 } }, "required": [ "userId", "secUid", "statHistory", "isPrivate", "isVerified", "postsCount", "avgLikes", "totalLikes", "avgComments", "bio", "interests", "lookalikes", "sponsoredPosts", "paidPostPerformanceViews", "sponsoredPostsMedianViews", "sponsoredPostsMedianLikes", "nonSponsoredPostsMedianViews", "nonSponsoredPostsMedianLikes" ] }, "TikTokReport": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "profile": { "$ref": "#/components/schemas/TikTokReportProfile" } }, "required": [ "profile" ] }, "YoutubeSort": { "type": "object", "properties": { "field": { "type": "string", "example": "followers", "default": "followers", "description": "Note: The following sort options are available only when the corresponding filter is applied: `keywords` `audienceGeo` `audienceLang` `audienceGender` `audienceAge` `followersGrowth` `viewsGrowth`.
\n\t\tSorting field in which order you want to get the results.", "enum": [ "engagements", "followers", "engagementRate", "keywords", "audienceGeo", "audienceLang", "audienceGender", "audienceAge", "audienceRelevance", "relevance", "followersGrowth", "views", "viewsGrowth" ] }, "value": { "type": "number", "example": 123, "description": "Only required for ```audienceGeo``` sorting." }, "direction": { "type": "string", "example": "desc", "default": "desc", "description": "Sorting direction", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] }, "YoutubeFilterOperations": { "type": "object", "properties": { "operator": { "type": "string", "description": "Logical operations used to combine filters.
Note: To use the `or` operator, you must apply it to at least two filters.", "enum": [ "and", "or", "not" ] }, "filter": { "type": "string", "description": "Filter to apply the operation on. If `keywords` or `relevance` are specified then you can not sort by these fields.", "enum": [ "followers", "engagements", "engagementRate", "lastposted", "bio", "keywords", "relevance", "language", "gender", "age", "location", "isVerified", "isOfficialArtist", "views" ] } }, "required": [ "operator", "filter" ] }, "YouTubeSearchInfluencerFilters": { "type": "object", "properties": { "followers": { "example": { "min": 20000, "max": 70000 }, "description": "We round followers value in the filter: whenever it's below 5k, we round it to the nearest thousand (4123 -> 4000; 4800-> 5000); when it's over 5k, we round it to the nearest 5,000 (27k -> 25k; 28k -> 30k).", "allOf": [ { "$ref": "#/components/schemas/FollowersCount" } ] }, "engagementRate": { "type": "number", "description": "Minimum engagement rate.", "maximum": 1, "minimum": 0, "example": 0.02 }, "location": { "example": [ 148838, 62149, 80500, 1428125, 304716 ], "description": "Filter by Influencer Location, You can get the locations with our locations api end point and send location ids in an array.", "maxItems": 20, "type": "array", "items": { "type": "number" } }, "language": { "type": "string", "example": "en", "description": "Filter by Influencer Language, You can get the languages code with our languages api end point.", "minLength": 1, "maxLength": 3 }, "lastposted": { "type": "number", "example": 90, "description": "Idenitfy influencers based on when they last posted. The number represents days and should be >= 30.", "minimum": 30 }, "relevance": { "example": [ "#cars", "@topgear" ], "description": "Filter by topic of influencers posts or by similarity of topic to other influencer. For example \"#cars #audi @topgear\" means \"Writing about #cars and #audi, has similar topic as @topgear account.\" You can only enter 100 usernames.", "type": "array", "items": { "type": "string" } }, "audienceRelevance": { "example": [ "@topgear" ], "description": "Filter by similarity of influencer's audience to another influencer's audience. For example \"@topgear\" means \"Has audience similar to @topgear account.\" Audience similarity means followers follow accounts with the same topics as those followed by @topgear's audience.", "type": "array", "items": { "type": "string" } }, "gender": { "type": "string", "example": "MALE", "description": "Filter by Influencer gender.", "enum": [ "MALE", "FEMALE", "KNOWN", "UNKNOWN" ] }, "age": { "description": "Filter by Influencer age, possible values are: 18, 25, 35, 45, 65. You have the option to utilize either the `min` field, the `max` field, or both concurrently. Any number that falls outside the accepted range will be disregarded.", "allOf": [ { "$ref": "#/components/schemas/InfluencerAgeRange" } ] }, "followersGrowthRate": { "description": "Growth rate by followers over a period of time.", "example": { "interval": "i6months", "value": 0.01, "operator": "gt" }, "allOf": [ { "$ref": "#/components/schemas/GrowthFilter" } ] }, "bio": { "type": "string", "example": "photos videos", "description": "Search influencer by their bio description and/or full name" }, "hasAudienceData": { "type": "boolean", "description": "Filter by whether the influencer has audience data available. If true, shows only accounts with audience data. If false, shows all accounts including those without audience data. If not specified, defaults to true." }, "views": { "description": "Filter by average views.", "allOf": [ { "$ref": "#/components/schemas/ViewsCount" } ] }, "hasContactDetails": { "description": "If Influencer has contact details.", "type": "array", "items": { "$ref": "#/components/schemas/ContactFilter" } }, "keywords": { "type": "string", "description": "Identify influencers by a phrase they use when speaking in their videos.", "example": "cats" }, "isVerified": { "type": "boolean", "description": "Set to `true` to filter by verified influencers." }, "isOfficialArtist": { "type": "boolean", "description": "Filter by isOfficialArtist." }, "viewsGrowthRate": { "description": "Growth rate by total views over a period of time.", "example": { "interval": "i1month", "value": 0.2, "operator": "gt" }, "allOf": [ { "$ref": "#/components/schemas/GrowthFilter" } ] }, "engagements": { "description": "Filter by engagements count. Pro tip: set `max` to 0 if you want to see results with hidden likes.", "allOf": [ { "$ref": "#/components/schemas/EngagementsCount" } ] }, "filterOperations": { "description": "Modify filter operation to use `and`, `or`, or `not`. Example: Search for influencer using the keyword *cars* AND `not` from the London or Female `or` interested in Beauty & Cosmetics.
If no operator is specified, the default operator applied is the `and` operator.", "type": "array", "items": { "$ref": "#/components/schemas/YoutubeFilterOperations" } } } }, "YouTubeSearchAudienceFilters": { "type": "object", "properties": { "location": { "example": [ { "id": 148838, "weight": 0.2 }, { "id": 62149, "weight": 0.2 }, { "id": 80500, "weight": 0.2 }, { "id": 1428125, "weight": 0.2 }, { "id": 304716, "weight": 0.2 } ], "description": "Filter by Audience Location, You can get the locations with our locations api end point and send location ids in an array together with their weight percentages. The default percentage is set to 20% (0.2)", "type": "array", "items": { "$ref": "#/components/schemas/LocationWeightedFilter" } }, "language": { "example": { "id": "en", "weight": 0.2 }, "description": "Filter by Audience Language, You can get the languages code with our languages api end point and send the location id within an object, together with the weight percentage. The default percentage is set to 20% (0.2)", "allOf": [ { "$ref": "#/components/schemas/LanguageWeightedFilter" } ] }, "gender": { "example": { "id": "MALE", "weight": 0.5 }, "description": "Filter by gender specific Audience, You can send the gender together with the weight percentage. The default percentage is set to 50% (0.5)", "allOf": [ { "$ref": "#/components/schemas/GenderWeightedFilter" } ] }, "age": { "example": [ { "id": "18-24", "weight": 0.3 }, { "id": "65-", "weight": 0.3 } ], "description": "Filter by Audience age. You can send the age together with the weight percentage. The default percentage is set to 30% (0.3)", "type": "array", "items": { "$ref": "#/components/schemas/AgeWeightedFilter" } }, "ageRange": { "example": { "min": "18", "max": "24", "weight": 0.3 }, "description": "Filter by audience age range. You can send the age range together with the weight percentage. The default percentage is set to 30% (0.3). You can't send both age and ageRange together.", "allOf": [ { "$ref": "#/components/schemas/AudienceAgeRange" } ] } } }, "YouTubeSearchFilters": { "type": "object", "properties": { "influencer": { "$ref": "#/components/schemas/YouTubeSearchInfluencerFilters" }, "audience": { "$ref": "#/components/schemas/YouTubeSearchAudienceFilters" } } }, "YouTubeSearchBody": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number", "default": 0, "minimum": 0, "maximum": 665 }, "calculationMethod": { "type": "string", "example": "median", "default": "median", "description": "If specified, this indicates the method used to compute average-based metrics, such as average number of likes, comments, shares, etc.", "enum": [ "median", "average" ] }, "sort": { "description": "Sorting", "example": { "field": "followers", "direction": "desc" }, "allOf": [ { "$ref": "#/components/schemas/YoutubeSort" } ] }, "filter": { "example": { "audience": { "location": [ { "weight": 0.2, "id": 148838 } ] }, "influencer": { "relevance": [ "#beauty_tips", "#beauty_hacks", "#beauty_products", "#beauty_of_nature", "#beautytips", "#beauty_haul", "#beauty_secrets", "#beauty_vlogger" ], "location": [ 148838 ], "gender": "FEMALE", "age": { "min": 25, "max": 45 }, "engagementRate": 0.02 } }, "allOf": [ { "$ref": "#/components/schemas/YouTubeSearchFilters" } ] } } }, "YoutubeProfileResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id of the influencer", "example": "173560420" }, "fullname": { "type": "string", "description": "Full name of Influencer", "example": "Instagram" }, "username": { "type": "string", "description": "Username of Influencer", "example": "instagram" }, "url": { "type": "string", "description": "Profile URL", "example": "https://www.instagram.com/instagram/" }, "picture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followers": { "type": "number", "description": "Follower count", "example": 313560626 }, "engagements": { "type": "number", "description": "Engagements", "example": 857994 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.0027362938100525414 }, "averageViews": { "type": "number", "example": 98124 }, "handle": { "type": "string", "example": "tseries", "description": "Unique and short YouTube channel identifier" } }, "required": [ "username", "url", "picture", "followers", "engagements", "engagementRate", "averageViews" ] }, "YoutubeInfluencerResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "User Id", "example": "173560420" }, "profile": { "description": "Profile info of influencer", "allOf": [ { "$ref": "#/components/schemas/YoutubeProfileResponse" } ] } }, "required": [ "userId", "profile" ] }, "YoutubeSearchResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Number of results", "example": 2 }, "lookalikes": { "description": "Lookalikes", "type": "array", "items": { "$ref": "#/components/schemas/YoutubeInfluencerResponse" } }, "directs": { "description": "Directs", "type": "array", "items": { "$ref": "#/components/schemas/YoutubeInfluencerResponse" } }, "isExactMatch": { "type": "boolean", "description": "Are the results exactly matching the filters you provided? If we don't find exact results then we try to show similar users by automatically removing some filters for you.", "example": true } }, "required": [ "total", "lookalikes", "directs", "isExactMatch" ] }, "YoutubeReportAudience": { "type": "object", "properties": { "notable": { "type": "number", "example": 0.07 }, "genders": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCode" } }, "geoCountries": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCodeName" } }, "ages": { "type": "array", "items": { "$ref": "#/components/schemas/WeightWithCode" } }, "gendersPerAge": { "type": "array", "items": { "$ref": "#/components/schemas/GenderPerAge" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/AudienceLanguage" } }, "notableUsers": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "audienceLookalikes": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "required": [ "notable", "genders", "geoCountries", "ages", "gendersPerAge", "languages", "notableUsers", "audienceLookalikes" ] }, "ContentTypeStatsYoutube": { "type": "object", "properties": { "engagements": { "type": "number", "example": 0 }, "engagementRate": { "type": "number", "example": 0 }, "avgLikes": { "type": "number", "example": 0 }, "avgComments": { "type": "number", "example": 0 }, "statHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeStatsHistory" } }, "avgViews": { "type": "number", "example": 0 }, "avgPosts4weeks": { "type": "number", "example": 0 } } }, "StatsByContentTypeYoutube": { "type": "object", "properties": { "all": { "example": {}, "description": "All content type stats", "allOf": [ { "$ref": "#/components/schemas/ContentTypeStatsYoutube" } ] }, "videos": { "example": {}, "description": "Videos stats", "allOf": [ { "$ref": "#/components/schemas/ContentTypeStatsYoutube" } ] }, "shorts": { "example": {}, "description": "Shorts stats", "allOf": [ { "$ref": "#/components/schemas/ContentTypeStatsYoutube" } ] }, "streams": { "example": {}, "description": "Streams stats", "allOf": [ { "$ref": "#/components/schemas/ContentTypeStatsYoutube" } ] } } }, "YoutubeRecentPost": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" }, "created": { "type": "string" }, "likes": { "type": "number" }, "comments": { "type": "number" }, "views": { "type": "number" }, "type": { "type": "string" }, "video": { "type": "string" }, "thumbnail": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "text", "url", "created", "type", "thumbnail", "title" ] }, "YoutubeSponsoredPost": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" }, "created": { "type": "string" }, "likes": { "type": "number" }, "comments": { "type": "number" }, "views": { "type": "number" }, "type": { "type": "string" }, "video": { "type": "string" }, "thumbnail": { "type": "string" }, "title": { "type": "string" }, "sponsors": { "type": "array", "items": { "$ref": "#/components/schemas/PostSponsor" } } }, "required": [ "id", "text", "url", "created", "type", "thumbnail", "title" ] }, "YouTubeReportProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User Id", "example": "173560420" }, "profile": { "description": "Influencer Profile", "allOf": [ { "$ref": "#/components/schemas/YoutubeProfileResponse" } ] }, "audience": { "description": "Audience data", "allOf": [ { "$ref": "#/components/schemas/YoutubeReportAudience" } ] }, "statsByContentType": { "description": "User stats separated by content type", "allOf": [ { "$ref": "#/components/schemas/StatsByContentTypeYoutube" } ] }, "recentPosts": { "description": "Recent Posts", "type": "array", "items": { "$ref": "#/components/schemas/YoutubeRecentPost" } }, "popularPosts": { "description": "Popular Posts", "type": "array", "items": { "$ref": "#/components/schemas/YoutubeRecentPost" } }, "city": { "type": "string", "example": "New york" }, "state": { "type": "string", "example": "California" }, "gender": { "type": "string", "example": "FEMALE", "enum": [ "MALE", "FEMALE" ] }, "statHistory": { "type": "array", "items": { "$ref": "#/components/schemas/MonthlyStat" } }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contacts" } }, "country": { "type": "string", "example": "US" }, "ageGroup": { "type": "string", "example": "18-24", "enum": [ "18-24", "25-34", "35-44", "45-64", "65-" ] }, "isVerified": { "type": "boolean", "example": true }, "postsCount": { "type": "number", "example": 37 }, "avgLikes": { "type": "number", "example": 18211 }, "totalViews": { "type": "number", "example": 1821211 }, "avgComments": { "type": "number", "example": 12321 }, "description": { "type": "string", "example": "CEO of #RockTok" }, "interests": { "type": "array", "items": { "$ref": "#/components/schemas/Interest" } }, "audienceCommenters": { "$ref": "#/components/schemas/YoutubeReportAudience" }, "lookalikesByTopics": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "audienceExtra": { "$ref": "#/components/schemas/AudienceExtraReportData" }, "sponsoredPosts": { "type": "array", "items": { "$ref": "#/components/schemas/YoutubeSponsoredPost" } }, "paidPostPerformance": { "type": "number", "example": 0.5 }, "paidPostPerformanceViews": { "type": "number", "example": 37 }, "sponsoredPostsMedianViews": { "type": "number", "example": 3127 }, "sponsoredPostsMedianLikes": { "type": "number", "example": 3743 }, "nonSponsoredPostsMedianViews": { "type": "number", "example": 267 }, "nonSponsoredPostsMedianLikes": { "type": "number", "example": 367 } }, "required": [ "userId", "statHistory", "postsCount", "avgLikes", "totalViews", "avgComments", "description", "interests", "audienceCommenters", "lookalikesByTopics", "sponsoredPosts", "paidPostPerformanceViews", "sponsoredPostsMedianViews", "sponsoredPostsMedianLikes", "nonSponsoredPostsMedianViews", "nonSponsoredPostsMedianLikes" ] }, "YouTubeReport": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "profile": { "$ref": "#/components/schemas/YouTubeReportProfile" } }, "required": [ "profile" ] }, "YoutubeUserInfluencer": { "type": "object", "properties": { "userId": { "type": "string", "example": "232192182", "description": "User Id" }, "username": { "type": "string", "example": "therock", "description": "Username" }, "fullname": { "type": "string", "example": "therock", "description": "User's full name" }, "picture": { "type": "string", "example": "https://imgigp.modash.io/v2?mb0KwpL92uYofJiSjDn1%2F6peL1lBwv3s%2BUvShHERlDbrEEwrWumIvR20xZeZXa0LDeIrcniqZeG9S%2F1a5s2Rx3FZdXrWpY%2BmSBJp1l%2FmBGon3rcHA4EfuatZqMhVBzAT", "description": "User's profile image URL" }, "followers": { "type": "number", "example": 313583625, "description": "User's number of followers" }, "isVerified": { "type": "boolean", "example": true, "description": "User has verified badge" }, "handle": { "type": "string", "example": "tseries", "description": "Unique and short YouTube channel identifier" } }, "required": [ "userId", "username", "fullname", "picture", "followers", "isVerified" ] }, "YoutubeListUsersResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/YoutubeUserInfluencer" } } }, "required": [ "users" ] }, "EmailsSearchBody": { "type": "object", "properties": { "emails": { "description": "List of emails to search", "minItems": 1, "maxItems": 1000, "example": [ "hello@modash.io", "non-existent@modash.io" ], "type": "array", "items": { "type": "string" } } }, "required": [ "emails" ] }, "MatchedEmailUser": { "type": "object", "properties": { "platform": { "type": "string", "description": "Platform", "example": "instagram" }, "userId": { "type": "string", "description": "User id of the influencer", "example": "173560420" }, "url": { "type": "string", "description": "URL of Influencer", "example": "https://www.instagram.com/instagram/" }, "username": { "type": "string", "description": "Username of Influencer", "example": "instagram" }, "fullname": { "type": "string", "description": "Full name of Influencer", "example": "Instagram" }, "picture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/3232323.jpg" }, "followers": { "type": "number", "description": "Follower count", "example": 313560626 }, "engagements": { "type": "number", "description": "Engagements", "example": 857994 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.0027362938100525414 }, "isVerified": { "type": "boolean", "description": "Is verified", "example": true } }, "required": [ "platform", "url", "username", "picture", "followers", "engagements", "engagementRate", "isVerified" ] }, "MatchedEmail": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address", "example": "example@modash.io" }, "users": { "description": "User details", "type": "array", "items": { "$ref": "#/components/schemas/MatchedEmailUser" } } }, "required": [ "email", "users" ] }, "EmailsSearchResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "matchedEmails": { "description": "Matches by email", "type": "array", "items": { "$ref": "#/components/schemas/MatchedEmail" } }, "notMatchedEmails": { "description": "Emails that were not matched", "type": "array", "items": { "type": "string" } }, "totalMatches": { "type": "number", "description": "Number of matched emails", "example": 1 } }, "required": [ "totalMatches" ] }, "PostCreationTimestampMs": { "type": "object", "properties": { "gte": { "type": "number", "description": "Filter posts by creation timestamp in milliseconds greater than or equal to this value" }, "lte": { "type": "number", "description": "Filter posts by creation timestamp in milliseconds less than or equal to this value" } } }, "CollaborationsPostsRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID / Username / Profile URL, User ID is preferred. For Youtube, if you want to extract brand collaboration, use the brand's domain name instead of the user ID (you can use Brand Dictionary endpoint to get the brand's domain name).", "example": "cristiano" }, "platform": { "type": "string", "enum": [ "instagram", "tiktok", "youtube" ], "example": "instagram" }, "collaboratorId": { "type": "string", "description": "If provided, only returns the collaboration posts between the specified influencer and brand. For Youtube, if you want to extract collaborations with a specific brand, use the brand's domain name instead of the user ID." }, "postCreationTimestampMs": { "description": "Filter the posts by creation timestamp in milliseconds", "example": { "gte": 1716835200000 }, "allOf": [ { "$ref": "#/components/schemas/PostCreationTimestampMs" } ] }, "cursor": { "type": "string", "description": "Cursor for pagination (only valid for 2 days)", "example": "" }, "limit": { "type": "number", "description": "Number of collaboration posts per page", "minimum": 1, "maximum": 30, "default": 30, "example": 10 }, "groupBrandCollaborations": { "type": "boolean", "default": true, "description": "If true, brand collaborations will be grouped across all platforms. This provides insights about the brand across all its social accounts.\n\nFor example: if you request brand collaborations for @cocacola on Instagram, you will get posts sponsored by Coca Cola on all three platforms (Instagram, Tiktok and Youtube).\n\nNote: In some cases, this may group regional or variant accounts (e.g., @cocacola_uk, @cocacola_us) when they represent the same brand identity. Set this flag to false if social media account-specific insights are needed." } }, "required": [ "id", "platform" ] }, "CollaborationsPost": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Post id", "example": "4333460164" }, "post_thumbnail": { "type": "string", "description": "Post thumbnail", "example": "https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f" }, "post_timestamp": { "type": "number", "description": "Post timestamp", "example": 1729502216000 }, "title": { "type": "string", "description": "Title", "example": "Title" }, "description": { "type": "string", "description": "Description", "example": "Description" }, "label": { "type": "string", "description": "Sponsorship category followed by the evidence. Possible categories: \t\t\t(1) Properly Disclosed Sponsorship - uses #ad, paid partnership flag, or explicitly indicates a partnership in text (e.g., \"I teamed up with X to...\"). \t\t\t(2) Likely Hidden Sponsorship - no clear disclosures, but other signals indicate a sponsorship (e.g., \"Use [CODE] for X% off\" or \"thanks @brand\"). \t\t\t(3) Unclear or Vague Sponsorship Hint - a mention/tag of a known sponsor, but without proper disclosures.", "example": "Properly Disclosed Sponsorship: is paid partnership flag" }, "collaboration_type": { "type": "string", "description": "Type of collaboration (if multiple types are relevant, we return the most relevant one)", "enum": [ "Paid", "Gifted", "Ambassador", "Affiliate", "Unspecified" ], "example": "Paid" }, "stats": { "description": "Stats", "allOf": [ { "$ref": "#/components/schemas/CollaborationsPostStats" } ] }, "sponsors": { "description": "Sponsors", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationsSponsor" } } }, "required": [ "post_id", "label", "collaboration_type" ] }, "CollaborationsPostsInfluencer": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID / Username / Profile URL", "example": "johndoe" }, "platform": { "type": "string", "enum": [ "instagram", "tiktok", "youtube" ], "example": "instagram" }, "is_more_available": { "type": "boolean", "description": "True if there are more collaboration posts available" }, "username": { "type": "string", "description": "Username", "example": "username" }, "user_picture": { "type": "string", "description": "Influencer user picture", "example": "https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f" }, "posts": { "description": "List of collaboration posts", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationsPost" } } }, "required": [ "id", "platform" ] }, "CollaborationsPostBrand": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Post id", "example": "4333460164" }, "post_thumbnail": { "type": "string", "description": "Post thumbnail", "example": "https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f" }, "post_timestamp": { "type": "number", "description": "Post timestamp", "example": 1729502216000 }, "title": { "type": "string", "description": "Title", "example": "Title" }, "description": { "type": "string", "description": "Description", "example": "Description" }, "label": { "type": "string", "description": "Sponsorship category followed by the evidence. Possible categories: \t\t\t(1) Properly Disclosed Sponsorship - uses #ad, paid partnership flag, or explicitly indicates a partnership in text (e.g., \"I teamed up with X to...\"). \t\t\t(2) Likely Hidden Sponsorship - no clear disclosures, but other signals indicate a sponsorship (e.g., \"Use [CODE] for X% off\" or \"thanks @brand\"). \t\t\t(3) Unclear or Vague Sponsorship Hint - a mention/tag of a known sponsor, but without proper disclosures.", "example": "Properly Disclosed Sponsorship: is paid partnership flag" }, "collaboration_type": { "type": "string", "description": "Type of collaboration (if multiple types are relevant, we return the most relevant one)", "enum": [ "Paid", "Gifted", "Ambassador", "Affiliate", "Unspecified" ], "example": "Paid" }, "stats": { "description": "Stats", "allOf": [ { "$ref": "#/components/schemas/CollaborationsPostStats" } ] }, "sponsors": { "description": "Sponsors", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationsSponsor" } }, "user_id": { "type": "string", "description": "User id", "example": "173560420" }, "username": { "type": "string", "description": "Username", "example": "username" }, "platform": { "type": "string", "description": "Platform", "example": "instagram" } }, "required": [ "post_id", "label", "collaboration_type" ] }, "CollaborationsPostsBrand": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID / Username / Profile URL", "example": "johndoe" }, "platform": { "type": "string", "enum": [ "instagram", "tiktok", "youtube" ], "example": "instagram" }, "is_more_available": { "type": "boolean", "description": "True if there are more collaboration posts available" }, "brand_name": { "type": "string", "description": "Brand name" }, "brand_domain": { "type": "string", "description": "Brand domain" }, "brand_logo": { "type": "string", "description": "Brand logo" }, "brand_category": { "type": "string", "description": "Brand category (if multiple categories are relevant, we return the most relevant one)", "enum": [ "Consumer Packaged Goods (CPG)", "Retail", "B2B/Enterprise/Industrial", "Classifieds & Local", "Food Beverage Restaurants", "Healthcare", "Media & Entertainment", "Technology", "Education", "Finance", "Automotive", "Travel", "Others", "Unknown" ], "example": "Travel" }, "posts": { "description": "Posts", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationsPostBrand" } } }, "required": [ "id", "platform", "brand_category" ] }, "CollaborationsPostsResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "cursor": { "type": "string", "description": "Cursor for pagination (only valid for 2 days)" }, "influencer": { "description": "Only available if the requested profile has influencer collaborations", "allOf": [ { "$ref": "#/components/schemas/CollaborationsPostsInfluencer" } ] }, "brand": { "description": "Only available if the requested profile has brand collaborations", "allOf": [ { "$ref": "#/components/schemas/CollaborationsPostsBrand" } ] } } }, "CollaborationsNotFoundResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false } } }, "CollaborationsSummaryRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID / Username / Profile URL, User ID is preferred. For Youtube, if you want to extract brand collaboration, use the brand's domain name instead of the user ID (you can use Brand Dictionary endpoint to get the brand's domain name).", "example": "cristiano" }, "platform": { "type": "string", "enum": [ "instagram", "tiktok", "youtube" ], "example": "instagram" }, "collaboratorId": { "type": "string", "description": "If provided, only returns the collaboration summary between the specified influencer and brand. For Youtube, if you want to extract collaborations summary with a specific brand, use the brand's domain name instead of the user ID.", "example": "" }, "cursor": { "type": "string", "description": "Cursor for pagination (only valid for 2 days)" }, "limit": { "type": "number", "description": "Number of collaboration summaries per page", "minimum": 1, "maximum": 10, "default": 10 }, "groupBrandCollaborations": { "type": "boolean", "default": true, "description": "If true, brand collaborations summaries will be grouped across all platforms. This provides insights about the brand across all its social accounts.\n\nFor example: if you request brand collaborations summary for @cocacola on Instagram, you will get collaboration summary for posts sponsored by Coca Cola on all three platforms (Instagram, Tiktok and Youtube).\n\nNote: In some cases, this may group regional or variant accounts (e.g., @cocacola_uk, @cocacola_us) when they represent the same brand identity. Set this flag to false if social media account-specific insights are needed." } }, "required": [ "id", "platform" ] }, "InstagramSummary": { "type": "object", "properties": { "total_distinct_posts": { "type": "number" }, "total_collaborations": { "type": "number" }, "total_plays": { "type": "number" }, "total_views": { "type": "number" }, "total_likes": { "type": "number" }, "total_comments": { "type": "number" } } }, "InfluencerSummaryInstagram": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "feed_photo": { "$ref": "#/components/schemas/InstagramSummary" }, "feed_video": { "$ref": "#/components/schemas/InstagramSummary" }, "reels_photo": { "$ref": "#/components/schemas/InstagramSummary" }, "reels_video": { "$ref": "#/components/schemas/InstagramSummary" }, "total_distinct_posts": { "type": "number" }, "total_distinct_brands": { "type": "number" } } }, "TiktokSummary": { "type": "object", "properties": { "total_distinct_posts": { "type": "number" }, "total_collaborations": { "type": "number" }, "total_likes": { "type": "number" }, "total_comments": { "type": "number" }, "total_views": { "type": "number" }, "total_shares": { "type": "number" }, "total_collects": { "type": "number" } } }, "InfluencerSummaryTiktok": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "photo": { "$ref": "#/components/schemas/TiktokSummary" }, "video": { "$ref": "#/components/schemas/TiktokSummary" }, "total_distinct_posts": { "type": "number" }, "total_distinct_brands": { "type": "number" } } }, "YoutubeSummary": { "type": "object", "properties": { "total_distinct_posts": { "type": "number" }, "total_collaborations": { "type": "number" }, "total_likes": { "type": "number" }, "total_comments": { "type": "number" }, "total_views": { "type": "number" } } }, "InfluencerSummaryYoutube": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "short": { "$ref": "#/components/schemas/YoutubeSummary" }, "video": { "$ref": "#/components/schemas/YoutubeSummary" }, "total_distinct_posts": { "type": "number" }, "total_distinct_brands": { "type": "number" } } }, "BaseInstagramSummary": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "feed_photo": { "$ref": "#/components/schemas/InstagramSummary" }, "feed_video": { "$ref": "#/components/schemas/InstagramSummary" }, "reels_photo": { "$ref": "#/components/schemas/InstagramSummary" }, "reels_video": { "$ref": "#/components/schemas/InstagramSummary" } } }, "BaseTiktokSummary": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "photo": { "$ref": "#/components/schemas/TiktokSummary" }, "video": { "$ref": "#/components/schemas/TiktokSummary" } } }, "BaseYoutubeSummary": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "short": { "$ref": "#/components/schemas/YoutubeSummary" }, "video": { "$ref": "#/components/schemas/YoutubeSummary" } } }, "InfluencerPerBrandSummary": { "type": "object", "properties": { "brand": { "description": "Brand data", "allOf": [ { "$ref": "#/components/schemas/CollaborationsSponsor" } ] }, "summary": { "oneOf": [ { "$ref": "#/components/schemas/BaseInstagramSummary" }, { "$ref": "#/components/schemas/BaseTiktokSummary" }, { "$ref": "#/components/schemas/BaseYoutubeSummary" } ], "description": "Performance summary for collaborations between the influencer and the brand" } }, "required": [ "brand", "summary" ] }, "CollaborationsSummaryInfluencer": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID / Username / Profile URL", "example": "johndoe" }, "platform": { "type": "string", "enum": [ "instagram", "tiktok", "youtube" ], "example": "instagram" }, "is_more_available": { "type": "boolean", "description": "True if there are more per-brand / per-influencer collaboration summmaries available" }, "summary": { "oneOf": [ { "$ref": "#/components/schemas/InfluencerSummaryInstagram" }, { "$ref": "#/components/schemas/InfluencerSummaryTiktok" }, { "$ref": "#/components/schemas/InfluencerSummaryYoutube" } ], "description": "Influencer collaboration summary for all brands" }, "per_brand_summary": { "description": "Influencer summary for collaborations with specific brands", "type": "array", "items": { "$ref": "#/components/schemas/InfluencerPerBrandSummary" } } }, "required": [ "id", "platform", "summary", "per_brand_summary" ] }, "BrandSummaryInstagram": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "feed_photo": { "$ref": "#/components/schemas/InstagramSummary" }, "feed_video": { "$ref": "#/components/schemas/InstagramSummary" }, "reels_photo": { "$ref": "#/components/schemas/InstagramSummary" }, "reels_video": { "$ref": "#/components/schemas/InstagramSummary" }, "total_distinct_posts": { "type": "number" }, "total_distinct_influencers": { "type": "number" } } }, "BrandSummaryTiktok": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "photo": { "$ref": "#/components/schemas/TiktokSummary" }, "video": { "$ref": "#/components/schemas/TiktokSummary" }, "total_distinct_posts": { "type": "number" }, "total_distinct_influencers": { "type": "number" } } }, "BrandSummaryYoutube": { "type": "object", "properties": { "total_collaborations": { "type": "number" }, "first_collaboration_timestamp": { "type": "number" }, "last_collaboration_timestamp": { "type": "number" }, "short": { "$ref": "#/components/schemas/YoutubeSummary" }, "video": { "$ref": "#/components/schemas/YoutubeSummary" }, "total_distinct_posts": { "type": "number" }, "total_distinct_influencers": { "type": "number" } } }, "CollaborationsInfluencer": { "type": "object", "properties": { "username": { "type": "string", "description": "Influencer username" }, "user_id": { "type": "string", "description": "Influencer user ID" }, "user_picture": { "type": "string", "description": "Influencer user picture" } } }, "BrandPerInfluencerSummary": { "type": "object", "properties": { "influencer": { "description": "Influencer data", "allOf": [ { "$ref": "#/components/schemas/CollaborationsInfluencer" } ] }, "summary": { "oneOf": [ { "$ref": "#/components/schemas/BaseInstagramSummary" }, { "$ref": "#/components/schemas/BaseTiktokSummary" }, { "$ref": "#/components/schemas/BaseYoutubeSummary" } ], "description": "Performance summary for collaborations between the brand and the influencer" } }, "required": [ "influencer", "summary" ] }, "CollaborationsSummaryBrand": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID / Username / Profile URL", "example": "johndoe" }, "platform": { "type": "string", "enum": [ "instagram", "tiktok", "youtube" ], "example": "instagram" }, "is_more_available": { "type": "boolean", "description": "True if there are more per-brand / per-influencer collaboration summmaries available" }, "summary": { "oneOf": [ { "$ref": "#/components/schemas/BrandSummaryInstagram" }, { "$ref": "#/components/schemas/BrandSummaryTiktok" }, { "$ref": "#/components/schemas/BrandSummaryYoutube" } ], "description": "Brand collaboration summary for all influencers" }, "per_influencer_summary": { "description": "Brand summary for collaborations with specific influencers", "type": "array", "items": { "$ref": "#/components/schemas/BrandPerInfluencerSummary" } } }, "required": [ "id", "platform", "summary", "per_influencer_summary" ] }, "CollaborationsSummaryResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "cursor": { "type": "string", "description": "Cursor for pagination (only valid for 2 days)" }, "influencer": { "description": "Only available if the requested profile has influencer collaborations", "allOf": [ { "$ref": "#/components/schemas/CollaborationsSummaryInfluencer" } ] }, "brand": { "description": "Only available if the requested profile has brand collaborations", "allOf": [ { "$ref": "#/components/schemas/CollaborationsSummaryBrand" } ] } } }, "AiSearchFiltersFollowers": { "type": "object", "properties": { "min": { "type": "number", "description": "Minimum followers count. Number will be approximated to the nearest range lower or equal to the given number. Ranges are: 1000, 3000, 5000, 10000, 15000, 20000, 25000, 35000, 50000, 75000, 100000, 125000, 150000, 175000, 200000, 250000, 300000, 350000, 500000, 1000000, 2000000, 3000000." }, "max": { "type": "number", "description": "Maximum followers count. Number will be approximated to the nearest range higher or equal to the given number. Ranges are: 1000, 3000, 5000, 10000, 15000, 20000, 25000, 35000, 50000, 75000, 100000, 125000, 150000, 175000, 200000, 250000, 300000, 350000, 500000, 1000000, 2000000, 3000000." } } }, "AiSearchFiltersAge": { "type": "object", "properties": { "min": { "type": "string", "description": "Minimum age range", "enum": [ "13", "18", "25", "35", "45", "65" ] }, "max": { "type": "string", "description": "Maximum age range", "enum": [ "18", "25", "35", "45", "65" ] } } }, "AiSearchFiltersEngagementRate": { "type": "object", "properties": { "min": { "type": "number", "description": "Minimum engagement rate (in percentage, 0.01 = 1%)", "example": 0.01 } } }, "IGAudienceFilters": { "type": "object", "properties": { "credibility": { "type": "number", "description": "Filter by Audience Credibility. The value is the inverse of fake followers, meaning 25% fake followers would translate to 0.75 of audience credibility.", "minimum": 0, "maximum": 1 } } }, "IGAiSearchFilters": { "type": "object", "properties": { "followersCount": { "description": "Filter by followers count", "allOf": [ { "$ref": "#/components/schemas/AiSearchFiltersFollowers" } ] }, "locations": { "description": "Filter by locations (use Locations dictionary endpoint to get the location IDs)", "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "number" } }, "gender": { "type": "string", "description": "Filter by gender; KNOWN -> male or female, UNKNOWN -> gender neutral", "enum": [ "MALE", "FEMALE", "KNOWN", "UNKNOWN" ] }, "lastPostedInDays": { "type": "number", "description": "Filter by influencers with latest post date, in days. P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "example": 90 }, "accountType": { "type": "string", "description": "Filter by account type", "enum": [ "creator", "brand" ] }, "language": { "type": "string", "description": "Filter by language (use Languages dictionary endpoint to get the language IDs)" }, "age": { "description": "Filter by age range", "allOf": [ { "$ref": "#/components/schemas/AiSearchFiltersAge" } ] }, "engagementRate": { "description": "Filter by engagement rate", "allOf": [ { "$ref": "#/components/schemas/AiSearchFiltersEngagementRate" } ] }, "hasEmail": { "type": "boolean", "description": "Filter by whether the influencer has an email" }, "brands": { "description": "Filter by brands (Use AI search's Brand Dictionary endpoint to get the brand names. P.S. this is a different endpoint than existing Brand Dictionary endpoint).", "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string" } }, "username": { "type": "string", "description": "Username to search for", "minLength": 1, "maxLength": 100 }, "maxPostAgeMonths": { "type": "number", "description": "Filter by the maximum age of the posts in months. Used to request more recent posts.", "enum": [ 3, 6, 9, 12 ] }, "contentType": { "type": "string", "description": "Filter by content type. Allowed values: video, image. If not provided, both video and image content will be returned.", "enum": [ "video", "image" ], "example": "video" }, "audience": { "description": "Filter by Audience", "allOf": [ { "$ref": "#/components/schemas/IGAudienceFilters" } ] } } }, "IGTextAiSearchRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 10000 }, "gender": "MALE", "lastPostedInDays": 90, "accountType": "creator", "language": "es", "age": { "min": "18" }, "engagementRate": { "min": 0.01 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/IGAiSearchFilters" } ] }, "query": { "type": "string", "description": "Example: woman with curly hair lifting weights. Queries can be sent in any language, but English yields the best results. Limit: 8192 characters or 512 words. If omitted, results are sorted by follower count.", "example": "woman with curly hair lifting weights", "minLength": 1, "maxLength": 8192 } } }, "AiSearchPostStats": { "type": "object", "properties": { "likesCount": { "type": "number", "description": "Likes count; -1 if likes count is hidden" }, "commentsCount": { "type": "number", "description": "Comments count; -1 if comments count is hidden" }, "playsCount": { "type": "number", "description": "Plays count" } }, "required": [ "likesCount", "commentsCount", "playsCount" ] }, "AiSearchPost": { "type": "object", "properties": { "id": { "type": "string", "description": "Post ID" }, "url": { "type": "string", "description": "Post URL" }, "thumbnail": { "type": "string", "description": "Post thumbnail URL" }, "stats": { "description": "Post statistics", "allOf": [ { "$ref": "#/components/schemas/AiSearchPostStats" } ] } }, "required": [ "id", "url", "thumbnail", "stats" ] }, "AiSearchProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID", "example": "173560420" }, "fullName": { "type": "string", "description": "Full name", "example": "Instagram" }, "username": { "type": "string", "description": "Username", "example": "instagram" }, "profilePicture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followersCount": { "type": "number", "description": "Followers count", "example": 313560626 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.01 }, "matchedPosts": { "description": "Posts ordered by relevance to the search query", "type": "array", "items": { "$ref": "#/components/schemas/AiSearchPost" } }, "recentPosts": { "description": "Recent posts (not necessarily relevant to the search query). P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "type": "array", "items": { "$ref": "#/components/schemas/AiSearchPost" } }, "accountCategory": { "type": "string", "description": "Account category", "example": "Sportsperson / Digital creator etc." } }, "required": [ "username", "profilePicture", "followersCount", "engagementRate", "matchedPosts", "recentPosts", "accountCategory" ] }, "AiSearchResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Total number of profiles matching the search query" }, "profiles": { "description": "List of influencer profiles matching the search query and filters", "type": "array", "items": { "$ref": "#/components/schemas/AiSearchProfile" } } }, "required": [ "total", "profiles" ] }, "IGImageAiSearchRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 10000 }, "gender": "MALE", "lastPostedInDays": 90, "accountType": "creator", "language": "es", "age": { "min": "18" }, "engagementRate": { "min": 0.01 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/IGAiSearchFilters" } ] }, "imageType": { "type": "string", "description": "Image type", "enum": [ "image/jpeg", "image/png", "image/webp" ] }, "base64Image": { "type": "string", "description": "Image (base64 encoded), max size 5MB", "format": "base64", "maxLength": 6990507 } }, "required": [ "imageType", "base64Image" ] }, "BaseAiSearchFilters": { "type": "object", "properties": { "followersCount": { "description": "Filter by followers count", "allOf": [ { "$ref": "#/components/schemas/AiSearchFiltersFollowers" } ] }, "locations": { "description": "Filter by locations (use Locations dictionary endpoint to get the location IDs)", "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "number" } }, "gender": { "type": "string", "description": "Filter by gender; KNOWN -> male or female, UNKNOWN -> gender neutral", "enum": [ "MALE", "FEMALE", "KNOWN", "UNKNOWN" ] }, "lastPostedInDays": { "type": "number", "description": "Filter by influencers with latest post date, in days. P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "example": 90 }, "accountType": { "type": "string", "description": "Filter by account type", "enum": [ "creator", "brand" ] }, "language": { "type": "string", "description": "Filter by language (use Languages dictionary endpoint to get the language IDs)" }, "age": { "description": "Filter by age range", "allOf": [ { "$ref": "#/components/schemas/AiSearchFiltersAge" } ] }, "engagementRate": { "description": "Filter by engagement rate", "allOf": [ { "$ref": "#/components/schemas/AiSearchFiltersEngagementRate" } ] }, "hasEmail": { "type": "boolean", "description": "Filter by whether the influencer has an email" }, "brands": { "description": "Filter by brands (Use AI search's Brand Dictionary endpoint to get the brand names. P.S. this is a different endpoint than existing Brand Dictionary endpoint).", "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string" } }, "username": { "type": "string", "description": "Username to search for", "minLength": 1, "maxLength": 100 }, "maxPostAgeMonths": { "type": "number", "description": "Filter by the maximum age of the posts in months. Used to request more recent posts.", "enum": [ 3, 6, 9, 12 ] }, "contentType": { "type": "string", "description": "Filter by content type. Allowed values: video, image. If not provided, both video and image content will be returned.", "enum": [ "video", "image" ], "example": "video" } } }, "TextAiSearchRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 13000 }, "gender": "FEMALE", "lastPostedInDays": 90, "accountType": "creator", "language": "en", "age": { "min": "18" }, "engagementRate": { "min": 0.04 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/BaseAiSearchFilters" } ] }, "query": { "type": "string", "description": "Example: woman with curly hair lifting weights. Queries can be sent in any language, but English yields the best results. Limit: 8192 characters or 512 words. If omitted, results are sorted by follower count.", "example": "woman with curly hair lifting weights", "minLength": 1, "maxLength": 8192 } } }, "TTAiSearchPostStats": { "type": "object", "properties": { "likesCount": { "type": "number", "description": "Likes count; -1 if likes count is hidden" }, "commentsCount": { "type": "number", "description": "Comments count; -1 if comments count is hidden" }, "sharesCount": { "type": "number", "description": "Shares count" }, "playsCount": { "type": "number", "description": "Plays count" }, "collectsCount": { "type": "number", "description": "Collects count" } }, "required": [ "likesCount", "commentsCount", "sharesCount", "playsCount", "collectsCount" ] }, "TTAiSearchPost": { "type": "object", "properties": { "id": { "type": "string", "description": "Post ID" }, "url": { "type": "string", "description": "Post URL" }, "thumbnail": { "type": "string", "description": "Post thumbnail URL" }, "stats": { "description": "Post statistics", "allOf": [ { "$ref": "#/components/schemas/TTAiSearchPostStats" } ] } }, "required": [ "id", "url", "thumbnail", "stats" ] }, "TTAiSearchProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID", "example": "173560420" }, "fullName": { "type": "string", "description": "Full name", "example": "Instagram" }, "username": { "type": "string", "description": "Username", "example": "instagram" }, "profilePicture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followersCount": { "type": "number", "description": "Followers count", "example": 313560626 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.01 }, "matchedPosts": { "description": "Posts ordered by relevance to the search query", "type": "array", "items": { "$ref": "#/components/schemas/TTAiSearchPost" } }, "recentPosts": { "description": "Recent posts (not necessarily relevant to the search query). P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "type": "array", "items": { "$ref": "#/components/schemas/TTAiSearchPost" } }, "accountCategory": { "type": "string", "description": "Account category", "example": "Sportsperson / Digital creator etc." } }, "required": [ "username", "profilePicture", "followersCount", "engagementRate", "matchedPosts", "recentPosts", "accountCategory" ] }, "TTAiSearchResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Total number of profiles matching the search query" }, "profiles": { "description": "List of influencer profiles matching the search query and filters", "type": "array", "items": { "$ref": "#/components/schemas/TTAiSearchProfile" } } }, "required": [ "total", "profiles" ] }, "ImageAiSearchRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 13000 }, "gender": "FEMALE", "lastPostedInDays": 90, "accountType": "creator", "language": "en", "age": { "min": "18" }, "engagementRate": { "min": 0.04 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/BaseAiSearchFilters" } ] }, "imageType": { "type": "string", "description": "Image type", "enum": [ "image/jpeg", "image/png", "image/webp" ] }, "base64Image": { "type": "string", "description": "Image (base64 encoded), max size 5MB", "format": "base64", "maxLength": 6990507 } }, "required": [ "imageType", "base64Image" ] }, "YTTextAiSearchRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 13000 }, "gender": "FEMALE", "lastPostedInDays": 90, "accountType": "creator", "language": "en", "age": { "min": "18" }, "engagementRate": { "min": 0.04 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/BaseAiSearchFilters" } ] }, "query": { "type": "string", "description": "Example: woman with curly hair lifting weights. Queries can be sent in any language, but English yields the best results. Limit: 8192 characters or 512 words. If omitted, results are sorted by follower count.", "example": "woman with curly hair lifting weights", "minLength": 1, "maxLength": 8192 } } }, "YTAiSearchPostStats": { "type": "object", "properties": { "likesCount": { "type": "number", "description": "Likes count; -1 if likes count is hidden" }, "commentsCount": { "type": "number", "description": "Comments count; -1 if comments count is hidden" }, "viewsCount": { "type": "number", "description": "Views count" } }, "required": [ "likesCount", "commentsCount", "viewsCount" ] }, "YTAiSearchPost": { "type": "object", "properties": { "id": { "type": "string", "description": "Post ID" }, "url": { "type": "string", "description": "Post URL" }, "thumbnail": { "type": "string", "description": "Post thumbnail URL" }, "stats": { "description": "Post statistics", "allOf": [ { "$ref": "#/components/schemas/YTAiSearchPostStats" } ] } }, "required": [ "id", "url", "thumbnail", "stats" ] }, "YTAiSearchProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID", "example": "173560420" }, "fullName": { "type": "string", "description": "Full name", "example": "Instagram" }, "username": { "type": "string", "description": "Username", "example": "instagram" }, "profilePicture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followersCount": { "type": "number", "description": "Followers count", "example": 313560626 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.01 }, "matchedPosts": { "description": "Posts ordered by relevance to the search query", "type": "array", "items": { "$ref": "#/components/schemas/YTAiSearchPost" } }, "recentPosts": { "description": "Recent posts (not necessarily relevant to the search query). P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "type": "array", "items": { "$ref": "#/components/schemas/YTAiSearchPost" } } }, "required": [ "username", "profilePicture", "followersCount", "engagementRate", "matchedPosts", "recentPosts" ] }, "YTAiSearchResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Total number of profiles matching the search query" }, "profiles": { "description": "List of influencer profiles matching the search query and filters", "type": "array", "items": { "$ref": "#/components/schemas/YTAiSearchProfile" } } }, "required": [ "total", "profiles" ] }, "IGLookalikeRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 10000 }, "gender": "MALE", "lastPostedInDays": 90, "accountType": "creator", "language": "es", "age": { "min": "18" }, "engagementRate": { "min": 0.01 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/IGAiSearchFilters" } ] }, "userId": { "type": "string", "description": "Instagram user ID or username of the source creator.", "example": "173560420" }, "targetPlatform": { "type": "string", "description": "Target platform to find lookalikes on. Can be the same as the source platform (same-platform) or different (cross-platform).", "enum": [ "instagram", "tiktok", "youtube" ], "default": "instagram" } }, "required": [ "userId" ] }, "LookalikeSourceProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID", "example": "173560420" }, "fullName": { "type": "string", "description": "Full name", "example": "Instagram" }, "username": { "type": "string", "description": "Username", "example": "instagram" }, "profilePicture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followersCount": { "type": "number", "description": "Followers count", "example": 313560626 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.01 }, "url": { "type": "string", "description": "Profile URL", "example": "https://instagram.com/instagram" }, "accountCategory": { "type": "string", "description": "Account category", "example": "Sportsperson / Digital creator etc." } }, "required": [ "username", "profilePicture", "followersCount", "engagementRate", "url" ] }, "IGLookalikeProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID", "example": "173560420" }, "fullName": { "type": "string", "description": "Full name", "example": "Instagram" }, "username": { "type": "string", "description": "Username", "example": "instagram" }, "profilePicture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followersCount": { "type": "number", "description": "Followers count", "example": 313560626 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.01 }, "recentPosts": { "description": "Recent posts (not necessarily relevant to the search query). P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "type": "array", "items": { "$ref": "#/components/schemas/AiSearchPost" } }, "accountCategory": { "type": "string", "description": "Account category", "example": "Sportsperson / Digital creator etc." } }, "required": [ "username", "profilePicture", "followersCount", "engagementRate", "recentPosts" ] }, "IGLookalikeResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Total number of lookalike profiles found" }, "sourceProfile": { "description": "The source creator profile used to find lookalikes", "allOf": [ { "$ref": "#/components/schemas/LookalikeSourceProfile" } ] }, "lookalikes": { "description": "List of lookalike influencer profiles", "type": "array", "items": { "$ref": "#/components/schemas/IGLookalikeProfile" } } }, "required": [ "total", "sourceProfile", "lookalikes" ] }, "TTLookalikeRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 13000 }, "gender": "FEMALE", "lastPostedInDays": 90, "accountType": "creator", "language": "en", "age": { "min": "18" }, "engagementRate": { "min": 0.04 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/BaseAiSearchFilters" } ] }, "userId": { "type": "string", "description": "TikTok user ID or username of the source creator.", "example": "107955" }, "targetPlatform": { "type": "string", "description": "Target platform to find lookalikes on. Can be the same as the source platform (same-platform) or different (cross-platform).", "enum": [ "instagram", "tiktok", "youtube" ], "default": "tiktok" } }, "required": [ "userId" ] }, "TTLookalikeProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID", "example": "173560420" }, "fullName": { "type": "string", "description": "Full name", "example": "Instagram" }, "username": { "type": "string", "description": "Username", "example": "instagram" }, "profilePicture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followersCount": { "type": "number", "description": "Followers count", "example": 313560626 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.01 }, "recentPosts": { "description": "Recent posts (not necessarily relevant to the search query). P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "type": "array", "items": { "$ref": "#/components/schemas/TTAiSearchPost" } }, "accountCategory": { "type": "string", "description": "Account category", "example": "Sportsperson / Digital creator etc." } }, "required": [ "username", "profilePicture", "followersCount", "engagementRate", "recentPosts" ] }, "TTLookalikeResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Total number of lookalike profiles found" }, "sourceProfile": { "description": "The source creator profile used to find lookalikes", "allOf": [ { "$ref": "#/components/schemas/LookalikeSourceProfile" } ] }, "lookalikes": { "description": "List of lookalike influencer profiles", "type": "array", "items": { "$ref": "#/components/schemas/TTLookalikeProfile" } } }, "required": [ "total", "sourceProfile", "lookalikes" ] }, "YTLookalikeRequest": { "type": "object", "properties": { "page": { "type": "number", "description": "Page number. The offset is calculated as page * pageSize, so changing pageSize between pages will shift the window and may cause duplicate or missed results.", "default": 0, "minimum": 0 }, "pageSize": { "type": "number", "description": "Number of results per page. Each result costs 0.025 credits.", "default": 6, "minimum": 1, "maximum": 50 }, "filters": { "description": "Additional filters to refine the search results", "example": { "followersCount": { "min": 13000 }, "gender": "FEMALE", "lastPostedInDays": 90, "accountType": "creator", "language": "en", "age": { "min": "18" }, "engagementRate": { "min": 0.04 }, "hasEmail": true, "maxPostAgeMonths": 3 }, "allOf": [ { "$ref": "#/components/schemas/BaseAiSearchFilters" } ] }, "userId": { "type": "string", "description": "YouTube channel ID or username of the source creator.", "example": "UCHnyfMqiRRG1u-2MsSQLbXA" }, "targetPlatform": { "type": "string", "description": "Target platform to find lookalikes on. Can be the same as the source platform (same-platform) or different (cross-platform).", "enum": [ "instagram", "tiktok", "youtube" ], "default": "youtube" } }, "required": [ "userId" ] }, "YTLookalikeProfile": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID", "example": "173560420" }, "fullName": { "type": "string", "description": "Full name", "example": "Instagram" }, "username": { "type": "string", "description": "Username", "example": "instagram" }, "profilePicture": { "type": "string", "description": "Profile Picture", "example": "https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg" }, "followersCount": { "type": "number", "description": "Followers count", "example": 313560626 }, "engagementRate": { "type": "number", "description": "Engagement rate", "example": 0.01 }, "recentPosts": { "description": "Recent posts (not necessarily relevant to the search query). P.S. we update profiles every 4 weeks and this lag should be considered when using this field.", "type": "array", "items": { "$ref": "#/components/schemas/YTAiSearchPost" } } }, "required": [ "username", "profilePicture", "followersCount", "engagementRate", "recentPosts" ] }, "YTLookalikeResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "total": { "type": "number", "description": "Total number of lookalike profiles found" }, "sourceProfile": { "description": "The source creator profile used to find lookalikes", "allOf": [ { "$ref": "#/components/schemas/LookalikeSourceProfile" } ] }, "lookalikes": { "description": "List of lookalike influencer profiles", "type": "array", "items": { "$ref": "#/components/schemas/YTLookalikeProfile" } } }, "required": [ "total", "sourceProfile", "lookalikes" ] }, "BrandsDictionaryBrandAccount": { "type": "object", "properties": { "platform": { "type": "string", "description": "Platform", "enum": [ "instagram", "tiktok", "youtube" ] }, "userId": { "type": "string", "description": "Brand user ID, not available for Youtube" }, "username": { "type": "string", "description": "Brand username, not available for Youtube" }, "domain": { "type": "string", "description": "Brand domain (if we do not have the domain then we return the brand's profile URL instead)" } }, "required": [ "platform", "domain" ] }, "BrandsDictionaryBrand": { "type": "object", "properties": { "name": { "type": "string", "description": "Brand name" }, "logoUrl": { "type": "string", "description": "Brand logo URL" }, "accounts": { "description": "Social platform accounts related to the brand", "type": "array", "items": { "$ref": "#/components/schemas/BrandsDictionaryBrandAccount" } } }, "required": [ "name", "logoUrl", "accounts" ] }, "BrandsDictionaryResponse": { "type": "object", "properties": { "error": { "type": "boolean", "description": "If there is an error", "example": false }, "result": { "description": "List of top 5 brands based on the search query", "type": "array", "items": { "$ref": "#/components/schemas/BrandsDictionaryBrand" } } }, "required": [ "result" ] } } }, "security": [ { "accessToken": [] } ] }