Search public profiles of creators

Created by Anoop, Modified on Thu, 14 Mar at 8:44 AM by Anoop

POST

/v1/social/creators/profiles/search

Search for creator profiles using publicly available data based on available filters.

Request

Security: Basic Auth

Body

application/json

work_platform_id

string

required

Target platform to search public profiles on

follower_count

object

Filter profiles by follower count

min

integer

Minimum followers

max

integer

Maximum followers

subscriber_count

object

Filter profiles by subscriber count

min

integer

Minimum subscribers

max

integer

Maximum subscribers

content_count

object

Filter profiles by content count

min

integer

Minimum number of contents

max

integer

Maximum number of contents

audience_gender

object

Filter profiles by audience gender

type

string

required

Gender type: ANY, FEMALE, MALE

Allowed values:

ANYFEMALEMALE

operator

string

required

Comparison operator, required if the gender is not ANY

Allowed values:

GTLT

percentage_value

integer

required

Percentage value for the comparison

creator_gender

string

Filter profiles by gender of the creator

Allowed values:

ANYFEMALEGENDER_NEUTRALMALE

audience_age

object

Filter profiles by audience age

min

integer

Minimum age of audience

max

integer

Maximum age of audience

creator_age

object

Filter profiles by creator age

min

integer

Minimum age of creator

max

integer

Maximum age of creator

description_keywords

array[string]

Filter profiles by a list of keywords that can be found in profile bio/introduction/description

is_verified

boolean

Filter profiles by platform verification status

has_contact_details

boolean

Filter profiles by availability of contact details

last_post_timestamp

string<date-time>

Filter profiles by the timestamp (ISO 8601) of last post

audience_language

array[object]

Filter profiles by audience's language, refer the "languages" table on this Airtable base

code

string

required

2 letter language code as per ISO 639-1

percentage_value

string

required

Percentage value for the comparison, which would always be a "greater than or equal to" comparison

creator_language

object

Filter profiles by profile's language, refer the "languages" table on this Airtable base

code

string

2 letter language code as per ISO 639-1

audience_interests

array[string]

List of interest names, which will return creators whose audience match even 1 of these interests. Only for Instagram. Refer the "interests and brands" table on this Airtable base.

creator_interests

array[string]

List of interest names, which will return creators who match even 1 of these interests. Only for Instagram. Refer the "interests and brands" table on this Airtable base.

audience_brand_affinities

array[string]

List of interest names, which will return creators whose audience match even 1 of these brand affinities. Only for Instagram. Refer the "interests and brands" table on this Airtable base.

creator_brand_affinities

array[string]

List of interest names, which will return creators who match even 1 of these brand affinities. Only for Instagram. Refer the "interests and brands" table on this Airtable base.

average_likes

object

Filter profiles by average likes

min

integer

Minimum average likes of creator

max

integer

Maximum average likes of creator

average_views

object

Filter profiles by average views

min

integer

Minimum average views of creator

max

integer

Maximum average views of creator

engagement_rate

object

Filter profiles by engagement rates

percentage_value

string

required

Percentage value for the comparison, which would always be a "greater than or equal to" comparison

has_sponsored_posts

boolean

Filter profiles which have sponsored posts. Only for Instagram.

brand_sponsors

array[string]

Filter profiles which have been sponsored by certain brands, which will return creators who match even 1 of these brands. Only for Instagram.

instagram_options

object

reel_views

object

Filter profiles by average reels views

audience_location

array[object]

List of locations, which will return creators whose audience match even 1 of these locations. Refer the "locations" table on this Airtable base.

name

string

Name of the location

percentage_value

integer

Percentage value for the comparison

creator_location

array[string]

List of locations, which will return creators who match even 1 of these locations. Refer the "locations" table on this Airtable base.

follower_growth

object

Filter profiles by follower growth rate

interval

integer

required

Time interval of growth

interval_unit

any

required

Unit of time interval

Allowed value:

MONTH

operator

string

required

Comparison operator

Allowed values:

GTLT

percentage_value

integer

required

Percentage value for the comparison

subscriber_growth

object

Filter profiles by subscriber growth rate

interval

integer

required

Time interval of growth

interval_unit

any

required

Unit of time interval

Allowed value:

MONTH

operator

string

required

Comparison operator

Allowed values:

GTLT

percentage_value

integer

required

Percentage value for the comparison

bio_phrase

array[string]

Filter profiles by the phrase they use in their bio

audience_lookalikes

string

Filter profiles whose audience looks like the given handle/username

creator_lookalikes

string

Filter profiles whose posts look like the given handle/username

account_type

string

Filter profiles by account type

Allowed values:

ANYBUSINESSCREATORPERSONAL

sort_by

object

required

Sorting order for the search results

field

string

required

Field to sort by

order

any

required

Ordering pattern

Allowed value:

DESCENDING

limit

integer

The number of search results to be returned. It can be between 1 to 100. The default value is 10.

Default:

offset

integer

The number of search results to skip. Use this argument for pagination. The default value is 0.

Default:

Responses

200

Returns search results according to the given filters

Headers

request-id

string<uuid>

required

Unique ID associated with this request. Please quote this request while requesting support.

Body

application/json

responses

200

metadata

to_date

data

array[CreatorProfileBasicDetails]

platform_username

string

required

Profile username on the platform

url

string<uri>

required

Profile URL from the platform

image_url

string<uri>

required

Profile image URL from the platform

follower_count

integer

required

Number of followers

subscriber_count

integer

required

Number of subscribers

is_verified

boolean

required

Whether the profile is verified by the platform

work_platform

WorkPlatformAttribute

required

full_name

string

required

Profile full name on the platform

introduction

string

required

Description of the profile.Show all...

platform_account_type

string

required

Account type of the profile, such as PERSONAL, CREATOR, BUSINESS, etc.

Allowed values:

PERSONALCREATORBUSINESS

gender

string

required

Gender of the profile

age_group

string

required

Age group of the profile

language

string

required

2 letter language code as per ISO 639-1, refer the "language" table on this Airtable base

content_count

integer

required

Number of contents posted by the profile

engagement_rate

number

required

Profile engagement rate, i.e., total likes of all posts divided by the number of followers

location

object

required

Profile location details, refer the "locations" table on this Airtable base.

contact_details

array[object]

required

Publicly available contact information about the profile

metadata

Metadata

required

Metadata object representing meta information about resources.

offset

integer

required

Offset value passed in the query parameter.

Default:

Example:

limit

integer

required

Limit value passed in the query parameter.

Default:

Example:

from_date

string or null

From date passed in the query parameter (YYYY-MM-DD).

Example:

2020-12-31

to_date

string or null

To date passed in the query parameter (YYYY-MM-DD).

Example:

2021-12-31