API Docs

v1.0.0Latest
POST

Search Creators

Search creators for instagram, tiktok and youtube based on various criteria.

Endpoint
POST /ask/search?platform={platform}
Request Query Parameters
Query parameters for searching creators
Field
Type
Required
Description
platform
string
Yes
Social media platform (instagram, tikTok, youtube)
Request Body
JSON payload body for searching creators
Field
Type
Required
Description
filter
object
Yes
Filter criteria for searching creators
sort
object {field: 'string', id: 0, direction: 'string'}
No
Sorting criteria for the search results (e.g., by followers, engagement)
paging
object {limit: number, skip: number }
Yes
Paging information for the search results (limit and skip)
Filter Object Values
Criteria to filter creators based on various attributes
Field
Type
Required
Description
audience_age
array<object> [{code: 'string', weight: 0}]
No
Filter by audience age groups with weight
audience_age_range
object {left_number: 'string', right_number: 'string', weight: 0, operator: 'string'}
No
Filter by audience age range with weight and operator
audience_brand
array<object> [{id: 0, weight: 0.0}]
No
Filter by audience brand with weight
audience_brand_category
array<object> [{id: 0, weight: 0.0}]
No
Filter by audience brand category with weight
audience_gender
object {code: 'string', weight: 0.0}
No
Filter by audience gender with weight
audience_geo
array<object> [{id: 0, weight: 0.0}]
No
Filter by audience geo with weight
audience_lang
object {code: 'string', weight: 0.0}
No
Filter by audience language with weight
audience_race
object {code: 'string', weight: 0.0}
No
Filter by audience race with weight
audience_relevance
object {value: 'string'}
No
Filter by audience relevance with weight
brand
array [0]
No
Filter by brand
brand_category
array [0]
No
Filter by brand category
engagements
object {left_number: 0, right_number: 0}
No
Filter by engagements
views
object {left_number: 0, right_number: 0}
No
Filter by views
reels_plays
object {left_number: 0, right_number: 0}
No
Filter by reels plays
followers
object {left_number: 0, right_number: 0}
No
Filter by followers
gender
object {code: 'string'}
No
Filter by gender
age
object {left_number: 0, right_number: 0}
No
Filter by age
geo
array<object> [{code: 0}]
No
Filter by geo
lang
object {code: 'string'}
No
Filter by language
followers_growth
object {interval: 'i1month', value: 0, operator: 'string'}
No
Filter by followers growth
total_views_growth
object {interval: 'i1month', value: 0, operator: 'string'}
No
Filter by total views growth
total_likes_growth
object {interval: 'i1month', value: 0, operator: 'string'}
No
Filter by total likes growth
relevance
object {value: 'string', weight: 0.0, threshold: 0.0}
No
Filter by relevance
text
string
No
Filter by text
keywords
string
No
Filter by keywords
text_tags
array<object> [{type: 'string', value: 'string', action: 'string'}]
No
Filter by text tags
engagement_rate
object {value: 0, operator: 'string'}
No
Filter by engagement rate
is_hidden
boolean
No
Filter by hidden status
is_verified
boolean
No
Filter by verified status
account_type
array [0]
No
Filter by account type
has_ads
boolean
No
Filter by ads presence
ads_brands
array [0]
No
Filter by ads brands
with_contact
array<object> [{type: 'string', action: 'string'}]
No
Filter by with contact
audience_credibility
number
No
Filter by audience credibility
audience_credibility_class
array ['string']
No
Filter by audience credibility class
filter_ids
array ['string']
No
Filter by filter IDs
is_official_artist
boolean
No
Filter by official artist status
last_posted
number
No
Filter by last posted
has_audience_data
boolean
No
Filter by audience data presence
username
object {value: 'string', operator: 'string'}
No
Filter by username
actions
array<object> [{filter: 'string', action: 'string'}]
No
Filter by actions
Example Request
curl -X POST "https://api.gateway.walee.ai/api/ask/search?platform={platform}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter":{"username":{"value":"atifaslam"}},"sort":{},"paging":{"limit": 5, "skip": 0}}'
Success Response
Successful search results
200OK
{
  "success": true,
  "message": "Search results fetched successfully",
  "payload": {
    "total": 0,
    "accounts": [
      {
        "account": {
          "audience_source": "string",
          "user_profile": {
            "account_type": 1,
            "avg_views": 0,
            "custom_name": "string",
            "engagement_rate": 0,
            "engagements": 0,
            "followers": 0,
            "fullname": "string",
            "is_verified": true,
            "picture": "string",
            "url": "string",
            "user_id": "string",
            "username": "string"
          },
          "search_result_id": "string",
          "hidden_result": true
        },
        "match": {
          "audience_likers": {
            "data": {
              "audience_ages": [
                {
                  "code": "13-17",
                  "weight": 0
                }
              ],
              "audience_age_range": {
                "code": "string",
                "weight": 0
              },
              "audience_brand_affinity": [
                {
                  "id": 0,
                  "name": "string",
                  "interest": [
                    {
                      "id": 0,
                      "name": "string"
                    }
                  ],
                  "weight": 0,
                  "affinity": 0
                }
              ],
              "audience_credibility": 0,
              "audience_ethnicities": [
                {
                  "code": "white",
                  "name": "White / Caucasian",
                  "weight": 0
                }
              ],
              "audience_genders": [
                {
                  "code": "MALE",
                  "weight": 0
                }
              ],
              "audience_genders_per_age": [
                {
                  "code": "13-17",
                  "male": 0,
                  "female": 0
                }
              ],
              "audience_geo": {
                "countries": [
                  {
                    "id": 0,
                    "name": "string",
                    "code": "string",
                    "weight": 0
                  }
                ],
                "states": [
                  {
                    "id": 0,
                    "name": "string",
                    "weight": 0,
                    "country": {
                      "id": 0,
                      "name": "string",
                      "code": "string"
                    }
                  }
                ],
                "cities": [
                  {
                    "id": 0,
                    "name": "string",
                    "coords": {
                      "lat": 0,
                      "lon": 0
                    },
                    "weight": 0,
                    "country": {
                      "id": 0,
                      "name": "string",
                      "code": "string"
                    }
                  }
                ]
              },
              "audience_interests": [
                {
                  "id": 0,
                  "name": "string",
                  "weight": 0
                }
              ],
              "audience_languages": [
                {
                  "code": "af",
                  "name": "string",
                  "weight": 0
                }
              ],
              "credibility_class": "string",
              "relevance": 0
            }
          },
          "user_profile": {
            "ads_brands": [
              {
                "id": 0,
                "name": "string",
                "interest": [
                  {
                    "id": 0,
                    "name": "string"
                  }
                ]
              }
            ],
            "age_group": "string",
            "avg_reels_plays": 0,
            "brand_affinity": [
              {
                "id": 0,
                "name": "string",
                "interest": [
                  {
                    "id": 0,
                    "name": "string"
                  }
                ]
              }
            ],
            "distance": 0,
            "followers_growth": 0,
            "gender": "MALE",
            "geo": {
              "city": {
                "id": 0,
                "name": "string",
                "coords": {
                  "lat": 0,
                  "lon": 0
                }
              },
              "state": {
                "id": 0,
                "name": "string",
                "coords": {
                  "lat": 0,
                  "lon": 0
                }
              },
              "country": {
                "id": 0,
                "name": "string",
                "coords": {
                  "lat": 0,
                  "lon": 0
                },
                "code": "string"
              }
            },
            "interests": [
              {
                "id": 0,
                "name": "string"
              }
            ],
            "language": {
              "code": "af",
              "name": "string"
            },
            "relevance": 0,
            "total_likes_growth": 0,
            "total_views_growth": 0
          }
        }
      }
    ],
    "shown_accounts": [
      0
    ],
    "cost": 0
  }
}
Error Response
Error retrieving search results
400Bad Request
{
  "success": false,
  "message": "Failed to fetch search results."
  "payload": {}
}
Error Response
Unexpected error occurred
500Internal Server Error
{
  "success": false,
  "message": "Something went wrong. Please try again later."
  "payload": {}
}