Documentation navigation
v1.0.0OAS 3.1.0

SocialQuery API

Download OpenAPI Document

Unified social media data API - one API key, one consistent response format, 68 platforms, 646 endpoints. This is a preview catalog; verify each required endpoint before integrating it.

SocialQuery
Server
https://socialquery.dev/v1
Production
Authentication RequiredapiKeyHeader
Name: x-api-key
Value: YOUR_SOCIALQUERY_API_KEY
Client Libraries
Shell Ruby Node.js PHP Python More
Shell Curl

meta

Account metadata - balance, usage, and no-credit account checks.

Operations
prism logo

prism

Composite intelligence endpoints. Prism lookup dispatches any supported social or commerce URL to the matching detail endpoint and returns the unified response.

Web logo

Web

Web operations available through the SocialQuery API.

Walmart logo

Walmart

Walmart operations available through the SocialQuery API.

Target logo

Target

Target operations available through the SocialQuery API.

Kohls logo

Kohls

Kohls operations available through the SocialQuery API.

Apple Music logo

Apple Music

Apple Music operations available through the SocialQuery API.

Twitch logo

Twitch

Twitch operations available through the SocialQuery API.

Home Depot logo

Home Depot

Home Depot operations available through the SocialQuery API.

Etsy logo

Etsy

Etsy operations available through the SocialQuery API.

Hacker News logo

Hacker News

Hacker News operations available through the SocialQuery API.

Tavily logo

Tavily

Tavily operations available through the SocialQuery API.

Bluesky logo

Bluesky

Bluesky operations available through the SocialQuery API.

Truth Social logo

Truth Social

Truth Social operations available through the SocialQuery API.

Telegram logo

Telegram

Telegram operations available through the SocialQuery API.

Kwai logo

Kwai

Kwai operations available through the SocialQuery API.

Trustpilot logo

Trustpilot

Trustpilot operations available through the SocialQuery API.

Wayfair logo

Wayfair

Wayfair operations available through the SocialQuery API.

Snapchat logo

Snapchat

Snapchat operations available through the SocialQuery API.

eBay logo

eBay

eBay operations available through the SocialQuery API.

Kick logo

Kick

Kick operations available through the SocialQuery API.

Perplexity logo

Perplexity

Perplexity operations available through the SocialQuery API.

Google News logo

Google News

Google News operations available through the SocialQuery API.

Linktree logo

Linktree

Linktree operations available through the SocialQuery API.

lnk.bio logo

lnk.bio

lnk.bio operations available through the SocialQuery API.

Linkme logo

Linkme

Linkme operations available through the SocialQuery API.

Komi logo

Komi

Komi operations available through the SocialQuery API.

Pillar logo

Pillar

Pillar operations available through the SocialQuery API.

Polymarket logo

Polymarket

Polymarket operations available through the SocialQuery API.

On-Page logo

On-Page

On-Page operations available through the SocialQuery API.

Product Hunt logo

Product Hunt

Product Hunt operations available through the SocialQuery API.

Read account metadata

Returns account metadata, available balance, and recent usage without deducting credits.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/meta
curl -X GET 'https://socialquery.dev/v1/meta' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "meta",
  "endpoint": "/v1/meta",
  "data": {
    "balance": 4999,
    "recent_deductions": 12
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Search Everywhere

Search everywhere. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

lookback_days

lookback_days parameter for this endpoint.

from_date

from_date parameter for this endpoint.

to_date

to_date parameter for this endpoint.

sources

sources parameter for this endpoint.

exclude

exclude parameter for this endpoint.

include_transcripts

include_transcripts parameter for this endpoint.

relevance

relevance parameter for this endpoint.

include

include parameter for this endpoint.

judgments

judgments parameter for this endpoint.

switch_from

switch_from parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/search/everywhere
curl -X GET 'https://socialquery.dev/v1/search/everywhere?query=kanye+west' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "search",
  "endpoint": "/v1/search/everywhere",
  "data": {
    "id": "string",
    "query": "kanye west",
    "status": "ok",
    "source": "search"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Search Forums

Search forums. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sources

sources parameter for this endpoint.

exclude

exclude parameter for this endpoint.

comments

comments parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

lookback_days

lookback_days parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

judgments

judgments parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/search/forums
curl -X GET 'https://socialquery.dev/v1/search/forums?query=airpods+pro+3+battery' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "search",
  "endpoint": "/v1/search/forums",
  "data": {
    "id": "string",
    "query": "airpods pro 3 battery",
    "status": "ok",
    "source": "search"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Search Creators

Search creators. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sources

sources parameter for this endpoint.

exclude

exclude parameter for this endpoint.

min_followers

min_followers parameter for this endpoint.

verified_only

verified_only parameter for this endpoint.

sort

sort parameter for this endpoint.

brief

brief parameter for this endpoint.

relevance

relevance parameter for this endpoint.

judgments

judgments parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/search/creators
curl -X GET 'https://socialquery.dev/v1/search/creators?query=skincare+routine' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "search",
  "endpoint": "/v1/search/creators",
  "data": {
    "id": "string",
    "query": "skincare routine",
    "status": "ok",
    "source": "search"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Search Multi

Search multi. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

platforms

platforms parameter for this endpoint.

since

since parameter for this endpoint.

tiktok.date_posted

tiktok.date_posted parameter for this endpoint.

tiktok.sort_by

tiktok.sort_by parameter for this endpoint.

tiktok.region

tiktok.region parameter for this endpoint.

instagram.date_posted

instagram.date_posted parameter for this endpoint.

youtube.uploadDate

youtube.uploadDate parameter for this endpoint.

youtube.sortBy

youtube.sortBy parameter for this endpoint.

youtube.type

youtube.type parameter for this endpoint.

youtube.duration

youtube.duration parameter for this endpoint.

youtube.region

youtube.region parameter for this endpoint.

reddit.sort

reddit.sort parameter for this endpoint.

reddit.timeframe

reddit.timeframe parameter for this endpoint.

threads.start_date

threads.start_date parameter for this endpoint.

threads.end_date

threads.end_date parameter for this endpoint.

twitter.sort

twitter.sort parameter for this endpoint.

facebook.start_date

facebook.start_date parameter for this endpoint.

facebook.end_date

facebook.end_date parameter for this endpoint.

facebook.recent_posts

facebook.recent_posts parameter for this endpoint.

facebook.location_uid

facebook.location_uid parameter for this endpoint.

linkedin.sort_by

linkedin.sort_by parameter for this endpoint.

linkedin.date_posted

linkedin.date_posted parameter for this endpoint.

linkedin.content_type

linkedin.content_type parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/search/multi
curl -X GET 'https://socialquery.dev/v1/search/multi?query=matcha+latte' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "search",
  "endpoint": "/v1/search/multi",
  "data": {
    "id": "string",
    "query": "matcha latte",
    "status": "ok",
    "source": "search"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Search News

Search news. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

countries

countries parameter for this endpoint.

engines

engines parameter for this endpoint.

sort

sort parameter for this endpoint.

time_range

time_range parameter for this endpoint.

from

from parameter for this endpoint.

to

to parameter for this endpoint.

publisher

publisher parameter for this endpoint.

depth

depth parameter for this endpoint.

max_legs

max_legs parameter for this endpoint.

group

group parameter for this endpoint.

judgments

judgments parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/search/news
curl -X GET 'https://socialquery.dev/v1/search/news?query=samsung+galaxy+launch' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "search",
  "endpoint": "/v1/search/news",
  "data": {
    "id": "string",
    "query": "samsung galaxy launch",
    "status": "ok",
    "source": "search"
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis search. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

page_type

page_type parameter for this endpoint.

search_mode

search_mode parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

order_by

order_by parameter for this endpoint.

filters

filters parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/search
curl -X GET 'https://socialquery.dev/v1/content_analysis/search?keyword=openai' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/search",
  "data": {
    "id": "string",
    "query": "openai",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis Summary

Content Analysis summary. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

page_type

page_type parameter for this endpoint.

positive_connotation_threshold

positive_connotation_threshold parameter for this endpoint.

sentiments_connotation_threshold

sentiments_connotation_threshold parameter for this endpoint.

internal_list_limit

internal_list_limit parameter for this endpoint.

filters

filters parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/summary
curl -X GET 'https://socialquery.dev/v1/content_analysis/summary?keyword=openai' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/summary",
  "data": {
    "id": "string",
    "query": "openai",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis Sentiment

Content Analysis sentiment. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

page_type

page_type parameter for this endpoint.

positive_connotation_threshold

positive_connotation_threshold parameter for this endpoint.

filters

filters parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/sentiment
curl -X GET 'https://socialquery.dev/v1/content_analysis/sentiment?keyword=openai' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/sentiment",
  "data": {
    "id": "string",
    "query": "openai",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis Rating Distribution

Content Analysis rating distribution. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

page_type

page_type parameter for this endpoint.

filters

filters parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/rating-distribution
curl -X GET 'https://socialquery.dev/v1/content_analysis/rating-distribution?keyword=iphone' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/rating-distribution",
  "data": {
    "id": "string",
    "query": "iphone",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis phrase trends. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

date_fromrequired

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

date_group

date_group parameter for this endpoint.

page_type

page_type parameter for this endpoint.

internal_list_limit

internal_list_limit parameter for this endpoint.

filters

filters parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/phrase-trends
curl -X GET 'https://socialquery.dev/v1/content_analysis/phrase-trends?keyword=openai&date_from=2025-01-01' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/phrase-trends",
  "data": {
    "id": "string",
    "query": "openai",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis category trends. Availability depends on the configured provider route.

Parameters

category_coderequired

category_code parameter for this endpoint.

date_fromrequired

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

date_group

date_group parameter for this endpoint.

internal_list_limit

internal_list_limit parameter for this endpoint.

filters

filters parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/category-trends
curl -X GET 'https://socialquery.dev/v1/content_analysis/category-trends?category_code=10021&date_from=2025-01-01' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/category-trends",
  "data": {
    "id": "string",
    "query": "10021",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis Languages

Content Analysis languages. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/languages
curl -X GET 'https://socialquery.dev/v1/content_analysis/languages' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/languages",
  "data": {
    "id": "string",
    "query": "/v1/content_analysis/languages",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis Locations

Content Analysis locations. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/locations
curl -X GET 'https://socialquery.dev/v1/content_analysis/locations' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/locations",
  "data": {
    "id": "string",
    "query": "/v1/content_analysis/locations",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis Categories

Content Analysis categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/categories
curl -X GET 'https://socialquery.dev/v1/content_analysis/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/categories",
  "data": {
    "id": "string",
    "query": "/v1/content_analysis/categories",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Content Analysis Filters

Content Analysis filters. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/content_analysis/filters
curl -X GET 'https://socialquery.dev/v1/content_analysis/filters' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/filters",
  "data": {
    "id": "string",
    "query": "/v1/content_analysis/filters",
    "status": "ok",
    "source": "content_analysis"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Lookup

Prism lookup. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/lookup
curl -X GET 'https://socialquery.dev/v1/prism/lookup?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/lookup",
  "data": {
    "resolved": {
      "input_url": "https://www.youtube.com/watch?v=A9TikdsD5eg",
      "platform": "youtube",
      "endpoint": "/v1/youtube/video",
      "reason": "YouTube video URL"
    },
    "legs": [
      {
        "status": "ok",
        "platform": "youtube",
        "endpoint": "/v1/youtube/video",
        "provider_route": [
          "youtube"
        ],
        "credits_estimated": 1
      }
    ],
    "data": {
      "provider": "youtube"
    }
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Comments

Prism comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

max

max parameter for this endpoint.

replies

replies parameter for this endpoint.

cursor

cursor parameter for this endpoint.

sort

sort parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/comments
curl -X GET 'https://socialquery.dev/v1/prism/comments?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/comments",
  "data": {
    "query": {
      "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Brand Mentions

Prism brand mentions. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

date_fromrequired

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

date_group

date_group parameter for this endpoint.

page_type

page_type parameter for this endpoint.

include

include parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/brand-mentions
curl -X GET 'https://socialquery.dev/v1/prism/brand-mentions?keyword=socialcrawl&date_from=2026-06-01' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/brand-mentions",
  "data": {
    "query": {
      "keyword": "socialcrawl"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 50,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Demand Signals

Prism demand signals. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

google_play_id

google_play_id parameter for this endpoint.

app_store_id

app_store_id parameter for this endpoint.

signals

signals parameter for this endpoint.

amazon_query

amazon_query parameter for this endpoint.

country

country parameter for this endpoint.

date_from

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/demand-signals
curl -X GET 'https://socialquery.dev/v1/prism/demand-signals?keyword=spotify' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/demand-signals",
  "data": {
    "query": {
      "keyword": "spotify"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Campaign

Prism campaign. Availability depends on the configured provider route.

Parameters

hashtag

hashtag parameter for this endpoint.

phrase

phrase parameter for this endpoint.

window_start

window_start parameter for this endpoint.

window_end

window_end parameter for this endpoint.

pre_days

pre_days parameter for this endpoint.

post_days

post_days parameter for this endpoint.

include

include parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/campaign
curl -X GET 'https://socialquery.dev/v1/prism/campaign?hashtag=summergiveaway' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/campaign",
  "data": {
    "query": {
      "hashtag": "summergiveaway"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 35,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Ai Visibility

Prism ai visibility. Availability depends on the configured provider route.

Parameters

brandrequired

brand parameter for this endpoint.

prompts

prompts parameter for this endpoint.

topic

topic parameter for this endpoint.

competitors

competitors parameter for this endpoint.

engines

engines parameter for this endpoint.

runs

runs parameter for this endpoint.

preset

preset parameter for this endpoint.

include

include parameter for this endpoint.

brand_domains

brand_domains parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/ai-visibility
curl -X GET 'https://socialquery.dev/v1/prism/ai-visibility?brand=socialcrawl&topic=social+media+data+api' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/ai-visibility",
  "data": {
    "query": {
      "brand": "socialcrawl"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Crisis Postmortem

Prism crisis postmortem. Availability depends on the configured provider route.

Parameters

brandrequired

brand parameter for this endpoint.

window_start

window_start parameter for this endpoint.

window_end

window_end parameter for this endpoint.

crisis_terms

crisis_terms parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/crisis-postmortem
curl -X GET 'https://socialquery.dev/v1/prism/crisis-postmortem?brand=acme' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/crisis-postmortem",
  "data": {
    "query": {
      "brand": "acme"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 35,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Crisis Radar

Prism crisis radar. Availability depends on the configured provider route.

Parameters

brandrequired

brand parameter for this endpoint.

sensitivity

sensitivity parameter for this endpoint.

confirm

confirm parameter for this endpoint.

baseline_days

baseline_days parameter for this endpoint.

date_to

date_to parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/crisis-radar
curl -X GET 'https://socialquery.dev/v1/prism/crisis-radar?brand=socialcrawl' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/crisis-radar",
  "data": {
    "query": {
      "brand": "socialcrawl"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 15,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Devtool Pulse

Prism devtool pulse. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

repo

repo parameter for this endpoint.

subreddit

subreddit parameter for this endpoint.

include

include parameter for this endpoint.

date_from

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/devtool-pulse
curl -X GET 'https://socialquery.dev/v1/prism/devtool-pulse?query=Bun' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/devtool-pulse",
  "data": {
    "query": {
      "query": "Bun"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Leads

Prism leads. Availability depends on the configured provider route.

Parameters

competitorrequired

competitor parameter for this endpoint.

product_category

product_category parameter for this endpoint.

freshness

freshness parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

offer

offer parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/leads
curl -X GET 'https://socialquery.dev/v1/prism/leads?competitor=notion' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/leads",
  "data": {
    "query": {
      "competitor": "notion"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 50,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Comment Leads

Prism comment leads. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

offer

offer parameter for this endpoint.

platform

platform parameter for this endpoint.

posts

posts parameter for this endpoint.

open

open parameter for this endpoint.

comments_per_post

comments_per_post parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/comment-leads
curl -X GET 'https://socialquery.dev/v1/prism/comment-leads?query=standing+desk+setup' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/comment-leads",
  "data": {
    "query": {
      "query": "standing desk setup"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Earned Media

Prism earned media. Availability depends on the configured provider route.

Parameters

brandrequired

brand parameter for this endpoint.

competitor

competitor parameter for this endpoint.

date_from

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

min_domain_rank

min_domain_rank parameter for this endpoint.

include

include parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/earned-media
curl -X GET 'https://socialquery.dev/v1/prism/earned-media?brand=Vercel' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/earned-media",
  "data": {
    "query": {
      "brand": "Vercel"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 25,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Truthsocial Pulse

Prism truthsocial pulse. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

drill

drill parameter for this endpoint.

posts

posts parameter for this endpoint.

news_query

news_query parameter for this endpoint.

include

include parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/truthsocial-pulse
curl -X GET 'https://socialquery.dev/v1/prism/truthsocial-pulse?handle=realDonaldTrump' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/truthsocial-pulse",
  "data": {
    "query": {
      "handle": "realDonaldTrump"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Launch Echo

Prism launch echo. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

repo

repo parameter for this endpoint.

threads

threads parameter for this endpoint.

date_from

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/launch-echo
curl -X GET 'https://socialquery.dev/v1/prism/launch-echo?query=Bun+1.2' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/launch-echo",
  "data": {
    "query": {
      "query": "Bun 1.2"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Audience Overlap

Prism audience overlap. Availability depends on the configured provider route.

Parameters

handle_arequired

handle_a parameter for this endpoint.

handle_brequired

handle_b parameter for this endpoint.

platform

platform parameter for this endpoint.

videos_per_creator

videos_per_creator parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/audience-overlap
curl -X GET 'https://socialquery.dev/v1/prism/audience-overlap?handle_a=mkbhd&handle_b=mrwhosetheboss' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/audience-overlap",
  "data": {
    "query": {
      "handle_a": "mkbhd"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Reputation

Prism reputation. Availability depends on the configured provider route.

Parameters

brandrequired

brand parameter for this endpoint.

sources

sources parameter for this endpoint.

country

country parameter for this endpoint.

depth

depth parameter for this endpoint.

place

place parameter for this endpoint.

axis

axis parameter for this endpoint.

app_store_id

app_store_id parameter for this endpoint.

google_play_id

google_play_id parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/reputation
curl -X GET 'https://socialquery.dev/v1/prism/reputation?brand=Notion' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/reputation",
  "data": {
    "query": {
      "brand": "Notion"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Employer Brand

Prism employer brand. Availability depends on the configured provider route.

Parameters

companyrequired

company parameter for this endpoint.

linkedin_url

linkedin_url parameter for this endpoint.

surfaces

surfaces parameter for this endpoint.

phrases

phrases parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

date_from

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/employer-brand
curl -X GET 'https://socialquery.dev/v1/prism/employer-brand?company=Stripe' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/employer-brand",
  "data": {
    "query": {
      "company": "Stripe"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Audience Questions

Prism audience questions. Availability depends on the configured provider route.

Parameters

topicrequired

topic parameter for this endpoint.

platforms

platforms parameter for this endpoint.

max_questions

max_questions parameter for this endpoint.

threads_per_source

threads_per_source parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/audience-questions
curl -X GET 'https://socialquery.dev/v1/prism/audience-questions?topic=kubernetes+operators' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/audience-questions",
  "data": {
    "query": {
      "topic": "kubernetes operators"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Product Reviews

Prism product reviews. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

asin

asin parameter for this endpoint.

gid

gid parameter for this endpoint.

sources

sources parameter for this endpoint.

country

country parameter for this endpoint.

depth

depth parameter for this endpoint.

competitors

competitors parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/product-reviews
curl -X GET 'https://socialquery.dev/v1/prism/product-reviews?query=AirPods+Pro+3' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/product-reviews",
  "data": {
    "query": {
      "query": "AirPods Pro 3"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Apps Lookup

Prism apps lookup. Availability depends on the configured provider route.

Parameters

title

title parameter for this endpoint.

google_play_id

google_play_id parameter for this endpoint.

app_store_id

app_store_id parameter for this endpoint.

stores

stores parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

match_threshold

match_threshold parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/apps-lookup
curl -X GET 'https://socialquery.dev/v1/prism/apps-lookup?title=Notion' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/apps-lookup",
  "data": {
    "query": {
      "title": "Notion"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Org Radar

Prism org radar. Availability depends on the configured provider route.

Parameters

orgrequired

org parameter for this endpoint.

repos

repos parameter for this endpoint.

sort

sort parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/org-radar
curl -X GET 'https://socialquery.dev/v1/prism/org-radar?org=vercel' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/org-radar",
  "data": {
    "query": {
      "org": "vercel"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 6,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Creator Vet

Prism creator vet. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

platform

platform parameter for this endpoint.

depth

depth parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/creator-vet
curl -X GET 'https://socialquery.dev/v1/prism/creator-vet?handle=mkbhd' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/creator-vet",
  "data": {
    "query": {
      "handle": "mkbhd"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 50,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Adverse Screen

Prism adverse screen. Availability depends on the configured provider route.

Parameters

linkedin

linkedin parameter for this endpoint.

twitter

twitter parameter for this endpoint.

facebook

facebook parameter for this endpoint.

instagram

instagram parameter for this endpoint.

threads

threads parameter for this endpoint.

tiktok

tiktok parameter for this endpoint.

name

name parameter for this endpoint.

employer

employer parameter for this endpoint.

city

city parameter for this endpoint.

categories

categories parameter for this endpoint.

since

since parameter for this endpoint.

limit

limit parameter for this endpoint.

screen_unconfirmed

screen_unconfirmed parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/adverse-screen
curl -X GET 'https://socialquery.dev/v1/prism/adverse-screen' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/adverse-screen",
  "data": {
    "query": {
      "linkedin": ""
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 25,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Find Accounts

Prism find accounts. Availability depends on the configured provider route.

Parameters

namerequired

name parameter for this endpoint.

type

type parameter for this endpoint.

platforms

platforms parameter for this endpoint.

employer

employer parameter for this endpoint.

location

location parameter for this endpoint.

website

website parameter for this endpoint.

candidates

candidates parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/find-accounts
curl -X GET 'https://socialquery.dev/v1/prism/find-accounts?name=Ogilvy' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/find-accounts",
  "data": {
    "query": {
      "name": "Ogilvy"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Mentions

Prism mentions. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

name

name parameter for this endpoint.

platforms

platforms parameter for this endpoint.

since

since parameter for this endpoint.

include_self

include_self parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/mentions
curl -X GET 'https://socialquery.dev/v1/prism/mentions?handle=nasa' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/mentions",
  "data": {
    "query": {
      "handle": "nasa"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Brief Check

Prism brief check. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

pointsrequired

points parameter for this endpoint.

forbidden

forbidden parameter for this endpoint.

require_disclosure

require_disclosure parameter for this endpoint.

brand

brand parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/brief-check
curl -X GET 'https://socialquery.dev/v1/prism/brief-check?url=https%3A%2F%2Fwww.tiktok.com%2F%40creator%2Fvideo%2F1&points=Use+the+code+SAVE20%2C+Show+the+app+on+camera' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/brief-check",
  "data": {
    "query": {
      "url": "https://www.tiktok.com/@creator/video/1"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 15,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Format Lift

Prism format lift. Availability depends on the configured provider route.

Parameters

platformrequired

platform parameter for this endpoint.

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/format-lift
curl -X GET 'https://socialquery.dev/v1/prism/format-lift?platform=youtube&handle=joshuaweissman' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/format-lift",
  "data": {
    "query": {
      "platform": "youtube"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 4,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Earliness

Prism earliness. Availability depends on the configured provider route.

Parameters

termrequired

term parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/earliness
curl -X GET 'https://socialquery.dev/v1/prism/earliness?term=swerve+app' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/earliness",
  "data": {
    "query": {
      "term": "swerve app"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 25,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Trend Board

Prism trend board. Availability depends on the configured provider route.

Parameters

country_coderequired

country_code parameter for this endpoint.

period

period parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/trend-board
curl -X GET 'https://socialquery.dev/v1/prism/trend-board?country_code=DE' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/trend-board",
  "data": {
    "query": {
      "country_code": "DE"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Audience Language

Prism audience language. Availability depends on the configured provider route.

Parameters

platformrequired

platform parameter for this endpoint.

handlerequired

handle parameter for this endpoint.

posts

posts parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/audience-language
curl -X GET 'https://socialquery.dev/v1/prism/audience-language?platform=tiktok&handle=charlidamelio' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/audience-language",
  "data": {
    "query": {
      "platform": "tiktok"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Korea Gap

Prism korea gap. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

include

include parameter for this endpoint.

date_from

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

display

display parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/korea-gap
curl -X GET 'https://socialquery.dev/v1/prism/korea-gap?query=Stanley+cup' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/korea-gap",
  "data": {
    "query": {
      "query": "Stanley cup"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 15,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Share Of Voice

Prism share of voice. Availability depends on the configured provider route.

Parameters

brandsrequired

brands parameter for this endpoint.

category_code

category_code parameter for this endpoint.

market_shares

market_shares parameter for this endpoint.

include

include parameter for this endpoint.

page_type

page_type parameter for this endpoint.

date_from

date_from parameter for this endpoint.

date_to

date_to parameter for this endpoint.

brand_descriptions

brand_descriptions parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/share-of-voice
curl -X GET 'https://socialquery.dev/v1/prism/share-of-voice?brands=notion%2Ccoda%2Cairtable' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/share-of-voice",
  "data": {
    "query": {
      "brands": "notion,coda,airtable"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Review Integrity

Prism review integrity. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

asin

asin parameter for this endpoint.

gid

gid parameter for this endpoint.

sources

sources parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/review-integrity
curl -X GET 'https://socialquery.dev/v1/prism/review-integrity?query=AirPods+Pro+3' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/review-integrity",
  "data": {
    "query": {
      "query": "AirPods Pro 3"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 30,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Answers

Prism answers. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

engines

engines parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/answers
curl -X GET 'https://socialquery.dev/v1/prism/answers?query=will+the+fed+cut+rates+in+september' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/answers",
  "data": {
    "query": {
      "query": "will the fed cut rates in september"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 15,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Video Intel

Prism video intel. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

comments

comments parameter for this endpoint.

include

include parameter for this endpoint.

app_demand

app_demand parameter for this endpoint.

claim

claim parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/video-intel
curl -X GET 'https://socialquery.dev/v1/prism/video-intel?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/video-intel",
  "data": {
    "query": {
      "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Voice

Prism voice. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

platforms

platforms parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/voice
curl -X GET 'https://socialquery.dev/v1/prism/voice?handle=nasa' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/voice",
  "data": {
    "query": {
      "handle": "nasa"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism App Reviews

Prism app reviews. Availability depends on the configured provider route.

Parameters

google_play_id

google_play_id parameter for this endpoint.

app_store_id

app_store_id parameter for this endpoint.

query

query parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

stores

stores parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/app-reviews
curl -X GET 'https://socialquery.dev/v1/prism/app-reviews?google_play_id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/app-reviews",
  "data": {
    "query": {
      "google_play_id": "1234567890"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Creator Card

Prism creator card. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

platforms

platforms parameter for this endpoint.

include

include parameter for this endpoint.

verify

verify parameter for this endpoint.

anchor

anchor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/creator-card
curl -X GET 'https://socialquery.dev/v1/prism/creator-card?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/creator-card",
  "data": {
    "query": {
      "handle": "mrbeast"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Handle Audit

Prism handle audit. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

platforms

platforms parameter for this endpoint.

sample

sample parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/handle-audit
curl -X GET 'https://socialquery.dev/v1/prism/handle-audit?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/handle-audit",
  "data": {
    "query": {
      "handle": "mrbeast"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Post Stats

Prism post stats. Availability depends on the configured provider route.

Parameters

urlsrequired

urls JSON body field for this endpoint.

include

include JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/prism/post-stats
curl -X POST 'https://socialquery.dev/v1/prism/post-stats' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"urls":["https://news.ycombinator.com/item?id=8863"]}'
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/post-stats",
  "data": {
    "query": {
      "urls": "[\"https://news.ycombinator.com/item?id=8863\"]"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Comment Lookup

Prism comment lookup. Availability depends on the configured provider route.

Parameters

itemsrequired

items JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/prism/comment-lookup
curl -X POST 'https://socialquery.dev/v1/prism/comment-lookup' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":[{"comment_url":"https://news.ycombinator.com/item?id=8863"}]}'
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/comment-lookup",
  "data": {
    "query": {
      "items": "[{\"comment_url\":\"https://news.ycombinator.com/item?id=8863\"}]"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Profiles

Prism profiles. Availability depends on the configured provider route.

Parameters

itemsrequired

items JSON body field for this endpoint.

include

include JSON body field for this endpoint.

since

since JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/prism/profiles
curl -X POST 'https://socialquery.dev/v1/prism/profiles' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":[{"comment_url":"https://news.ycombinator.com/item?id=8863"}]}'
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/profiles",
  "data": {
    "query": {
      "items": "[{\"comment_url\":\"https://news.ycombinator.com/item?id=8863\"}]"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Jobs

Prism jobs. Availability depends on the configured provider route.

Parameters

endpointrequired

endpoint JSON body field for this endpoint.

itemsrequired

items JSON body field for this endpoint.

include

include JSON body field for this endpoint.

since

since JSON body field for this endpoint.

webhook

webhook JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/prism/jobs
curl -X POST 'https://socialquery.dev/v1/prism/jobs' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":[{"comment_url":"https://news.ycombinator.com/item?id=8863"}]}'
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/jobs",
  "data": {
    "query": {
      "endpoint": ""
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Jobs

Prism jobs. Availability depends on the configured provider route.

Parameters

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/jobs
curl -X GET 'https://socialquery.dev/v1/prism/jobs' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/jobs",
  "data": {
    "query": {
      "cursor": ""
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Jobs {Job Id}

Prism jobs {job id}. Availability depends on the configured provider route.

Parameters

job_idrequired

job_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/jobs/{job_id}
curl -X GET 'https://socialquery.dev/v1/prism/jobs/bj_3kP9x2LmQ7' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/jobs/{job_id}",
  "data": {
    "query": {
      "job_id": "bj_3kP9x2LmQ7"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Prism Investigate

Prism investigate. Availability depends on the configured provider route.

Parameters

goalrequired

goal parameter for this endpoint.

budget

budget parameter for this endpoint.

max_steps

max_steps parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/prism/investigate
curl -X GET 'https://socialquery.dev/v1/prism/investigate?goal=Find+Korean+skincare+creators+on+TikTok+whose+commenters+ask+where+to+buy' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/investigate",
  "data": {
    "query": {
      "goal": "Find Korean skincare creators on TikTok whose commenters ask where to buy"
    },
    "answer": {
      "status": "partial",
      "summary": "Prism completed the available source legs and returned a unified result.",
      "confidence": 0.92
    },
    "coverage": {
      "requested": 2,
      "succeeded": 2,
      "failed": 0
    },
    "legs": []
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile

Linkedin profile. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile
curl -X GET 'https://socialquery.dev/v1/linkedin/profile?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company

Linkedin company. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company
curl -X GET 'https://socialquery.dev/v1/linkedin/company?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fmicrosoft%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/company/microsoft/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company By Domain

Linkedin company by domain. Availability depends on the configured provider route.

Parameters

domainrequired

domain parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/by-domain
curl -X GET 'https://socialquery.dev/v1/linkedin/company/by-domain?domain=microsoft.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/by-domain",
  "data": {
    "id": "string",
    "query": "microsoft.com",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Similar

Linkedin profile similar. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/similar
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/similar?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/similar",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search Companies

Linkedin search companies. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

company_size

company_size parameter for this endpoint.

has_jobs

has_jobs parameter for this endpoint.

industry_ids

industry_ids parameter for this endpoint.

geocode

geocode parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/companies
curl -X GET 'https://socialquery.dev/v1/linkedin/search/companies?query=microsoft' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/companies",
  "data": {
    "id": "string",
    "query": "microsoft",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Posted Jobs

Linkedin profile posted jobs. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/posted-jobs
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/posted-jobs?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fjipeng-han%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/posted-jobs",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/jipeng-han/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Job Hiring Team

Linkedin job hiring team. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/job/hiring-team
curl -X GET 'https://socialquery.dev/v1/linkedin/job/hiring-team?id=4463963538' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/job/hiring-team",
  "data": {
    "id": "string",
    "query": "4463963538",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Articles

Linkedin profile articles. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/articles
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/articles?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/articles",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Article

Linkedin article. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/article
curl -X GET 'https://socialquery.dev/v1/linkedin/article?url=https%3A%2F%2Fwww.linkedin.com%2Fpulse%2Fhidden-costs-unreliable-electricity-bill-gates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/article",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/pulse/hidden-costs-unreliable-electricity-bill-gates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Article Comments

Linkedin article comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/article/comments
curl -X GET 'https://socialquery.dev/v1/linkedin/article/comments?url=https%3A%2F%2Fwww.linkedin.com%2Fpulse%2F2024-corporate-climate-pivot-bill-gates-u89mc%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/article/comments",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/pulse/2024-corporate-climate-pivot-bill-gates-u89mc/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Article Reactions

Linkedin article reactions. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/article/reactions
curl -X GET 'https://socialquery.dev/v1/linkedin/article/reactions?url=https%3A%2F%2Fwww.linkedin.com%2Fpulse%2F2024-corporate-climate-pivot-bill-gates-u89mc%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/article/reactions",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/pulse/2024-corporate-climate-pivot-bill-gates-u89mc/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search Hashtag

Linkedin search hashtag. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/hashtag
curl -X GET 'https://socialquery.dev/v1/linkedin/search/hashtag?query=hiring' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/hashtag",
  "data": {
    "id": "string",
    "query": "hiring",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Activity

Linkedin profile activity. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/activity
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/activity?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fadamselipsky%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/activity",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/adamselipsky/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company Also Viewed

Linkedin company also viewed. Availability depends on the configured provider route.

Parameters

company_id

company_id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/also-viewed
curl -X GET 'https://socialquery.dev/v1/linkedin/company/also-viewed?company_id=1441' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/also-viewed",
  "data": {
    "id": "string",
    "query": "1441",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company Employees Count

Linkedin company employees count. Availability depends on the configured provider route.

Parameters

company_idrequired

company_id parameter for this endpoint.

geocode

geocode parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/employees-count
curl -X GET 'https://socialquery.dev/v1/linkedin/company/employees-count?company_id=1441' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/employees-count",
  "data": {
    "id": "string",
    "query": "1441",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Interests Schools

Linkedin profile interests schools. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/interests/schools
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/interests/schools?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/interests/schools",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Interests Newsletters

Linkedin profile interests newsletters. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/interests/newsletters
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/interests/newsletters?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/interests/newsletters",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Interests Top Voices

Linkedin profile interests top voices. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/interests/top-voices
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/interests/top-voices?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/interests/top-voices",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Position Skills

Linkedin profile position skills. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/position-skills
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/position-skills?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Ftedgaubert%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/position-skills",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/tedgaubert/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Top Position

Linkedin profile top position. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/top-position
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/top-position?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fadamselipsky%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/top-position",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/adamselipsky/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search People By Url

Linkedin search people by url. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/people/by-url
curl -X GET 'https://socialquery.dev/v1/linkedin/search/people/by-url?url=https%3A%2F%2Fwww.linkedin.com%2Fsearch%2Fresults%2Fpeople%2F%3Fkeywords%3Dkyc' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/people/by-url",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/search/results/people/?keywords=kyc",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile All

Linkedin profile all. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

urls

urls parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/all
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/all?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/all",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Complete

Linkedin profile complete. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/complete
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/complete?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fryanroslansky%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/complete",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/ryanroslansky/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile With Posts

Linkedin profile with posts. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/with-posts
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/with-posts?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fadamselipsky%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/with-posts",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/adamselipsky/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Post With Comments

Linkedin post with comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/post/with-comments
curl -X GET 'https://socialquery.dev/v1/linkedin/post/with-comments?url=https%3A%2F%2Fwww.linkedin.com%2Ffeed%2Fupdate%2Furn%3Ali%3Aactivity%3A7501466755261820928' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/post/with-comments",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Post

Linkedin post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/post
curl -X GET 'https://socialquery.dev/v1/linkedin/post?url=https%3A%2F%2Fwww.linkedin.com%2Ffeed%2Fupdate%2Furn%3Ali%3Aactivity%3A7501466755261820928' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/post",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search People

Linkedin search people. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

first_name

first_name parameter for this endpoint.

last_name

last_name parameter for this endpoint.

title

title parameter for this endpoint.

current_company

current_company parameter for this endpoint.

past_company

past_company parameter for this endpoint.

school

school parameter for this endpoint.

industry

industry parameter for this endpoint.

geocode_location

geocode_location parameter for this endpoint.

profile_language

profile_language parameter for this endpoint.

service_category

service_category parameter for this endpoint.

follower_of

follower_of parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/people
curl -X GET 'https://socialquery.dev/v1/linkedin/search/people?query=Bill+Gates' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/people",
  "data": {
    "id": "string",
    "query": "Bill Gates",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company People

Linkedin company people. Availability depends on the configured provider route.

Parameters

company_idrequired

company_id parameter for this endpoint.

page

page parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/people
curl -X GET 'https://socialquery.dev/v1/linkedin/company/people?company_id=1035' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/people",
  "data": {
    "id": "string",
    "query": "1035",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Post Comments

Linkedin post comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

post_type

post_type parameter for this endpoint.

sort_order

sort_order parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/post/comments
curl -X GET 'https://socialquery.dev/v1/linkedin/post/comments?url=https%3A%2F%2Fwww.linkedin.com%2Ffeed%2Fupdate%2Furn%3Ali%3Aactivity%3A7244804629786419202' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/feed/update/urn:li:activity:7244804629786419202",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Posts

Linkedin profile posts. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

limit

limit parameter for this endpoint.

urn

urn parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/posts
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/posts?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/posts",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Reactions

Linkedin profile reactions. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

urn

urn parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/reactions
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/reactions?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/reactions",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Post Reposts

Linkedin post reposts. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

page

page parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/post/reposts
curl -X GET 'https://socialquery.dev/v1/linkedin/post/reposts?url=https%3A%2F%2Fwww.linkedin.com%2Ffeed%2Fupdate%2Furn%3Ali%3Aactivity%3A7501466755261820928' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/post/reposts",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Group Posts

Linkedin group posts. Availability depends on the configured provider route.

Parameters

group_idrequired

group_id parameter for this endpoint.

page

page parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/group/posts
curl -X GET 'https://socialquery.dev/v1/linkedin/group/posts?group_id=62438' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/group/posts",
  "data": {
    "id": "string",
    "query": "62438",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company Affiliated Pages

Linkedin company affiliated pages. Availability depends on the configured provider route.

Parameters

company_idrequired

company_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/affiliated-pages
curl -X GET 'https://socialquery.dev/v1/linkedin/company/affiliated-pages?company_id=1035' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/affiliated-pages",
  "data": {
    "id": "string",
    "query": "1035",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Post Comments Replies

Linkedin post comments replies. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

comment_idrequired

comment_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/post/comments/replies
curl -X GET 'https://socialquery.dev/v1/linkedin/post/comments/replies?url=https%3A%2F%2Fwww.linkedin.com%2Ffeed%2Fupdate%2Furn%3Ali%3Aactivity%3A7501466755261820928&comment_id=7501480403283886080' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/post/comments/replies",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Experiences

Linkedin profile experiences. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/experiences
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/experiences?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/experiences",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Educations

Linkedin profile educations. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/educations
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/educations?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/educations",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Skills

Linkedin profile skills. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/skills
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/skills?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/skills",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Honors

Linkedin profile honors. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/honors
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/honors?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/honors",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Certifications

Linkedin profile certifications. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/certifications
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/certifications?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/certifications",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Publications

Linkedin profile publications. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/publications
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/publications?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/publications",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Volunteers

Linkedin profile volunteers. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/volunteers
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/volunteers?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/volunteers",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Recommendations

Linkedin profile recommendations. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

type

type parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/recommendations
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/recommendations?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/recommendations",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Interests Companies

Linkedin profile interests companies. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/interests/companies
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/interests/companies?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/interests/companies",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Interests Groups

Linkedin profile interests groups. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

urn

urn parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/interests/groups
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/interests/groups?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/interests/groups",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Images

Linkedin profile images. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

urn

urn parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/images
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/images?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/images",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Videos

Linkedin profile videos. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

urn

urn parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/videos
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/videos?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/videos",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Comments

Linkedin profile comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

urn

urn parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/comments
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/comments?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/comments",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Post Reactions

Linkedin post reactions. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

page

page parameter for this endpoint.

type

type parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/post/reactions
curl -X GET 'https://socialquery.dev/v1/linkedin/post/reactions?url=https%3A%2F%2Fwww.linkedin.com%2Ffeed%2Fupdate%2Furn%3Ali%3Aactivity%3A7501466755261820928' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/post/reactions",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company Jobs

Linkedin company jobs. Availability depends on the configured provider route.

Parameters

company_idrequired

company_id parameter for this endpoint.

page

page parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

experience_level

experience_level parameter for this endpoint.

job_type

job_type parameter for this endpoint.

remote

remote parameter for this endpoint.

easy_apply

easy_apply parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/jobs
curl -X GET 'https://socialquery.dev/v1/linkedin/company/jobs?company_id=1035' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/jobs",
  "data": {
    "id": "string",
    "query": "1035",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search Jobs

Linkedin search jobs. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

experience_level

experience_level parameter for this endpoint.

job_type

job_type parameter for this endpoint.

remote

remote parameter for this endpoint.

easy_apply

easy_apply parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

company

company parameter for this endpoint.

geocode

geocode parameter for this endpoint.

industry_ids

industry_ids parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/jobs
curl -X GET 'https://socialquery.dev/v1/linkedin/search/jobs?query=marketing' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/jobs",
  "data": {
    "id": "string",
    "query": "marketing",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search Location

Linkedin search location. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/location
curl -X GET 'https://socialquery.dev/v1/linkedin/search/location?query=London' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/location",
  "data": {
    "id": "string",
    "query": "London",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search Schools

Linkedin search schools. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/schools
curl -X GET 'https://socialquery.dev/v1/linkedin/search/schools?query=Stanford' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/schools",
  "data": {
    "id": "string",
    "query": "Stanford",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search Industry

Linkedin search industry. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/industry
curl -X GET 'https://socialquery.dev/v1/linkedin/search/industry?query=Software' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/industry",
  "data": {
    "id": "string",
    "query": "Software",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile About

Linkedin profile about. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

urn

urn parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/about
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/about?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/about",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Contact

Linkedin profile contact. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/contact
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/contact?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/contact",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Stats

Linkedin profile stats. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/stats
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/stats?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/stats",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company Job Count

Linkedin company job count. Availability depends on the configured provider route.

Parameters

company_idrequired

company_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/job-count
curl -X GET 'https://socialquery.dev/v1/linkedin/company/job-count?company_id=1035' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/job-count",
  "data": {
    "id": "string",
    "query": "1035",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company Insights

Linkedin company insights. Availability depends on the configured provider route.

Parameters

company_idrequired

company_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/insights
curl -X GET 'https://socialquery.dev/v1/linkedin/company/insights?company_id=1035' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/insights",
  "data": {
    "id": "string",
    "query": "1035",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Group

Linkedin group. Availability depends on the configured provider route.

Parameters

group_idrequired

group_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/group
curl -X GET 'https://socialquery.dev/v1/linkedin/group?group_id=62438' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/group",
  "data": {
    "id": "string",
    "query": "62438",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Job

Linkedin job. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

include_skills

include_skills parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/job
curl -X GET 'https://socialquery.dev/v1/linkedin/job?id=4462185352' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/job",
  "data": {
    "id": "string",
    "query": "4462185352",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Company Posts

Linkedin company posts. Availability depends on the configured provider route.

Parameters

company_idrequired

company_id parameter for this endpoint.

page

page parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/company/posts
curl -X GET 'https://socialquery.dev/v1/linkedin/company/posts?company_id=1035' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/company/posts",
  "data": {
    "id": "string",
    "query": "1035",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Ad

Linkedin ad. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/ad
curl -X GET 'https://socialquery.dev/v1/linkedin/ad?url=https%3A%2F%2Fwww.linkedin.com%2Fad-library%2Fdetail%2F1515437353' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/ad",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/ad-library/detail/1515437353",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Linkedin ads search. Availability depends on the configured provider route.

Parameters

company

company parameter for this endpoint.

keyword

keyword parameter for this endpoint.

companyId

companyId parameter for this endpoint.

countries

countries parameter for this endpoint.

startDate

startDate parameter for this endpoint.

endDate

endDate parameter for this endpoint.

paginationToken

paginationToken parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/ads/search
curl -X GET 'https://socialquery.dev/v1/linkedin/ads/search?company=microsoft' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/ads/search",
  "data": {
    "id": "string",
    "query": "microsoft",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Posts Archive

Linkedin profile posts archive. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

limit

limit parameter for this endpoint.

pagination_token

pagination_token parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/posts/archive
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/posts/archive?url=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fwilliamhgates%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/posts/archive",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/in/williamhgates/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Search Posts

Linkedin search posts. Availability depends on the configured provider route.

Parameters

page

page parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

content_type

content_type parameter for this endpoint.

from_company

from_company parameter for this endpoint.

from_member

from_member parameter for this endpoint.

query

query parameter for this endpoint.

limit

limit parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/search/posts
curl -X GET 'https://socialquery.dev/v1/linkedin/search/posts?query=ai+agents' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/search/posts",
  "data": {
    "id": "string",
    "query": "10",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Post Transcript

Linkedin post transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/post/transcript
curl -X GET 'https://socialquery.dev/v1/linkedin/post/transcript?url=https%3A%2F%2Fwww.linkedin.com%2Fposts%2Fgemini-35-flash-is-a-step-forward-for-google-ugcPost-7465082215316525056-MHBd%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/post/transcript",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/posts/gemini-35-flash-is-a-step-forward-for-google-ugcPost-7465082215316525056-MHBd/",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

LinkedIn Profile Full

Linkedin profile full. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

posts

posts parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkedin/profile/full
curl -X GET 'https://socialquery.dev/v1/linkedin/profile/full?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fmicrosoft' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkedin",
  "endpoint": "/v1/linkedin/profile/full",
  "data": {
    "id": "string",
    "query": "https://www.linkedin.com/company/microsoft",
    "status": "ok",
    "source": "linkedin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Profile

Instagram profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

trim

trim parameter for this endpoint.

contact_email

contact_email parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/profile
curl -X GET 'https://socialquery.dev/v1/instagram/profile?handle=instagram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/profile",
  "data": {
    "id": "string",
    "query": "instagram",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Profile About

Instagram profile about. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/profile/about
curl -X GET 'https://socialquery.dev/v1/instagram/profile/about?handle=instagram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/profile/about",
  "data": {
    "id": "string",
    "query": "instagram",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Profile Posts

Instagram profile posts. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

next_max_id

next_max_id parameter for this endpoint.

trim

trim parameter for this endpoint.

exclude_pinned

exclude_pinned parameter for this endpoint.

recent_days

recent_days parameter for this endpoint.

include

include parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/profile/posts
curl -X GET 'https://socialquery.dev/v1/instagram/profile/posts?handle=instagram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/profile/posts",
  "data": {
    "id": "string",
    "query": "instagram",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Post

Instagram post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

region

region parameter for this endpoint.

trim

trim parameter for this endpoint.

download_media

download_media parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/post
curl -X GET 'https://socialquery.dev/v1/instagram/post?url=https%3A%2F%2Fwww.instagram.com%2Fp%2FDcCH2ZygIiP%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/post",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/p/DcCH2ZygIiP/",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Post Comments

Instagram post comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

sort

sort parameter for this endpoint.

cursor

cursor parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

scan_pages

scan_pages parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/post/comments
curl -X GET 'https://socialquery.dev/v1/instagram/post/comments?url=https%3A%2F%2Fwww.instagram.com%2Fp%2FDXidPIVDU6M%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/p/DXidPIVDU6M/",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Comment

Instagram comment. Availability depends on the configured provider route.

Parameters

comment_url

comment_url parameter for this endpoint.

post_url

post_url parameter for this endpoint.

comment_id

comment_id parameter for this endpoint.

author_username

author_username parameter for this endpoint.

text_contains

text_contains parameter for this endpoint.

deep_scan

deep_scan parameter for this endpoint.

position_hint

position_hint parameter for this endpoint.

max

max parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/comment
curl -X GET 'https://socialquery.dev/v1/instagram/comment' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/comment",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/p/CnpPou9hWqq/c/18007013966365752/",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Basic Profile

Instagram basic profile. Availability depends on the configured provider route.

Parameters

userId

userId parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/basic-profile
curl -X GET 'https://socialquery.dev/v1/instagram/basic-profile' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/basic-profile",
  "data": {
    "id": "string",
    "query": "314216",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Profile Reels

Instagram profile reels. Availability depends on the configured provider route.

Parameters

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

user_id

user_id parameter for this endpoint.

handle

handle parameter for this endpoint.

max_id

max_id parameter for this endpoint.

trim

trim parameter for this endpoint.

exclude_pinned

exclude_pinned parameter for this endpoint.

recent_days

recent_days parameter for this endpoint.

include

include parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/profile/reels
curl -X GET 'https://socialquery.dev/v1/instagram/profile/reels?user_id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/profile/reels",
  "data": {
    "id": "string",
    "query": "2026-09-01",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Highlights

Instagram highlights. Availability depends on the configured provider route.

Parameters

user_id

user_id parameter for this endpoint.

handle

handle parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/highlights
curl -X GET 'https://socialquery.dev/v1/instagram/highlights?user_id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/highlights",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Highlight Detail

Instagram highlight detail. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/highlight/detail
curl -X GET 'https://socialquery.dev/v1/instagram/highlight/detail' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/highlight/detail",
  "data": {
    "id": "string",
    "query": "18067016518767507",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Search Reels

Instagram search reels. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

page

page parameter for this endpoint.

region

region parameter for this endpoint.

include

include parameter for this endpoint.

country

country parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/search/reels
curl -X GET 'https://socialquery.dev/v1/instagram/search/reels?query=workout+routine' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/search/reels",
  "data": {
    "id": "string",
    "query": "workout routine",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Media Transcript

Instagram media transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/media/transcript
curl -X GET 'https://socialquery.dev/v1/instagram/media/transcript?url=https%3A%2F%2Fwww.instagram.com%2Freel%2FDHsD6HGqJhp%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/media/transcript",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/reel/DHsD6HGqJhp/",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Media Screen Text

Instagram media screen text. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/media/screen-text
curl -X GET 'https://socialquery.dev/v1/instagram/media/screen-text?url=https%3A%2F%2Fwww.instagram.com%2Fp%2FDdEqEl5Dl-S%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/media/screen-text",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/p/DdEqEl5Dl-S/",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram User Embed

Instagram user embed. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/user/embed
curl -X GET 'https://socialquery.dev/v1/instagram/user/embed?handle=instagram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/user/embed",
  "data": {
    "id": "string",
    "query": "instagram",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Audio Reels

Instagram audio reels. Availability depends on the configured provider route.

Parameters

audio_idrequired

audio_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/audio/reels
curl -X GET 'https://socialquery.dev/v1/instagram/audio/reels?audio_id=1392969992841787' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/audio/reels",
  "data": {
    "id": "string",
    "query": "1392969992841787",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Search Hashtag

Instagram search hashtag. Availability depends on the configured provider route.

Parameters

hashtagrequired

hashtag parameter for this endpoint.

type

type parameter for this endpoint.

cursor

cursor parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/search/hashtag
curl -X GET 'https://socialquery.dev/v1/instagram/search/hashtag?hashtag=makeup' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/search/hashtag",
  "data": {
    "id": "string",
    "query": "makeup",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Search Profiles

Instagram search profiles. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/search/profiles
curl -X GET 'https://socialquery.dev/v1/instagram/search/profiles?query=yoga' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/search/profiles",
  "data": {
    "id": "string",
    "query": "yoga",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram reels trending. Availability depends on the configured provider route.

Parameters

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/reels/trending
curl -X GET 'https://socialquery.dev/v1/instagram/reels/trending' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/reels/trending",
  "data": {
    "id": "string",
    "query": "",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Followers

Instagram followers. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

coverage

coverage parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/followers
curl -X GET 'https://socialquery.dev/v1/instagram/followers?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/followers",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Following

Instagram following. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

coverage

coverage parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/following
curl -X GET 'https://socialquery.dev/v1/instagram/following?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/following",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Similar

Instagram similar. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/similar
curl -X GET 'https://socialquery.dev/v1/instagram/similar?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/similar",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Post Likers

Instagram post likers. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/post/likers
curl -X GET 'https://socialquery.dev/v1/instagram/post/likers?url=https%3A%2F%2Fwww.instagram.com%2Fp%2FCnpPou9hWqq%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/post/likers",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/p/CnpPou9hWqq/",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Post Stats

Instagram post stats. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/post/stats
curl -X GET 'https://socialquery.dev/v1/instagram/post/stats?url=https%3A%2F%2Fwww.instagram.com%2Fp%2FCnpPou9hWqq%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/post/stats",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/p/CnpPou9hWqq/",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Tagged

Instagram tagged. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/tagged
curl -X GET 'https://socialquery.dev/v1/instagram/tagged?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/tagged",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Location Posts

Instagram location posts. Availability depends on the configured provider route.

Parameters

location_idrequired

location_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/location/posts
curl -X GET 'https://socialquery.dev/v1/instagram/location/posts?location_id=331004901' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/location/posts",
  "data": {
    "id": "string",
    "query": "331004901",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Engagement

Instagram engagement. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/engagement
curl -X GET 'https://socialquery.dev/v1/instagram/engagement?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/engagement",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Search Location

Instagram search location. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/search/location
curl -X GET 'https://socialquery.dev/v1/instagram/search/location?query=Paris' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/search/location",
  "data": {
    "id": "string",
    "query": "Paris",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/search
curl -X GET 'https://socialquery.dev/v1/instagram/search?query=nike' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/search",
  "data": {
    "id": "string",
    "query": "nike",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram search popular. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/search/popular
curl -X GET 'https://socialquery.dev/v1/instagram/search/popular?query=basketball' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/search/popular",
  "data": {
    "id": "string",
    "query": "basketball",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Post Comment Replies

Instagram post comment replies. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

comment_idrequired

comment_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/post/comment/replies
curl -X GET 'https://socialquery.dev/v1/instagram/post/comment/replies?url=https%3A%2F%2Fwww.instagram.com%2Freel%2FC8rKmYvsrck&comment_id=18038110327814211' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/post/comment/replies",
  "data": {
    "id": "string",
    "query": "https://www.instagram.com/reel/C8rKmYvsrck",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Username Suggestions

Instagram username suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/username-suggestions
curl -X GET 'https://socialquery.dev/v1/instagram/username-suggestions?query=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/username-suggestions",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Search Music

Instagram search music. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/search/music
curl -X GET 'https://socialquery.dev/v1/instagram/search/music?query=beyonce' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/search/music",
  "data": {
    "id": "string",
    "query": "beyonce",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Stories

Instagram stories. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/stories
curl -X GET 'https://socialquery.dev/v1/instagram/stories?handle=instagram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/stories",
  "data": {
    "id": "string",
    "query": "instagram",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Story Download

Instagram story download. Availability depends on the configured provider route.

Parameters

user_id

user_id parameter for this endpoint.

story_id

story_id parameter for this endpoint.

safe_url

safe_url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/story/download
curl -X GET 'https://socialquery.dev/v1/instagram/story/download?user_id=25025320&story_id=3926693776893966474' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/story/download",
  "data": {
    "id": "string",
    "query": "25025320",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram music trending. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/music/trending
curl -X GET 'https://socialquery.dev/v1/instagram/music/trending' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/music/trending",
  "data": {
    "id": "string",
    "query": "/v1/instagram/music/trending",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Profile Full

Instagram profile full. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

posts

posts parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/profile/full
curl -X GET 'https://socialquery.dev/v1/instagram/profile/full?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/profile/full",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Profile Reels Full

Instagram profile reels full. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/profile/reels/full
curl -X GET 'https://socialquery.dev/v1/instagram/profile/reels/full?handle=sid.and.listen' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/profile/reels/full",
  "data": {
    "id": "string",
    "query": "sid.and.listen",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Instagram Profile Posts Full

Instagram profile posts full. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/instagram/profile/posts/full
curl -X GET 'https://socialquery.dev/v1/instagram/profile/posts/full?handle=sid.and.listen' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/profile/posts/full",
  "data": {
    "id": "string",
    "query": "sid.and.listen",
    "status": "ok",
    "source": "instagram"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Profile

Tiktok profile. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/profile
curl -X GET 'https://socialquery.dev/v1/tiktok/profile?handle=charlidamelio' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/profile",
  "data": {
    "id": "string",
    "query": "charlidamelio",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Profile Videos

Tiktok profile videos. Availability depends on the configured provider route.

Parameters

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

max_cursor

max_cursor parameter for this endpoint.

region

region parameter for this endpoint.

trim

trim parameter for this endpoint.

format

format parameter for this endpoint.

brief

brief parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/profile/videos
curl -X GET 'https://socialquery.dev/v1/tiktok/profile/videos?handle=charlidamelio' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/profile/videos",
  "data": {
    "id": "string",
    "query": "2026-09-01",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Post

Tiktok post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

region

region parameter for this endpoint.

trim

trim parameter for this endpoint.

download_media

download_media parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/post
curl -X GET 'https://socialquery.dev/v1/tiktok/post?url=https%3A%2F%2Fwww.tiktok.com%2F%40charlidamelio%2Fvideo%2F7321485815660738859' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/post",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/@charlidamelio/video/7321485815660738859",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Post Comments

Tiktok post comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

sort

sort parameter for this endpoint.

scan_pages

scan_pages parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/post/comments
curl -X GET 'https://socialquery.dev/v1/tiktok/post/comments?url=https%3A%2F%2Fwww.tiktok.com%2F%40stoolpresidente%2Fvideo%2F7623818255903329566' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/@stoolpresidente/video/7623818255903329566",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Video Comment Replies

Tiktok video comment replies. Availability depends on the configured provider route.

Parameters

comment_idrequired

comment_id parameter for this endpoint.

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/video/comment/replies
curl -X GET 'https://socialquery.dev/v1/tiktok/video/comment/replies?comment_id=7623828115408274207&url=https%3A%2F%2Fwww.tiktok.com%2F%40stoolpresidente%2Fvideo%2F7623818255903329566' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/video/comment/replies",
  "data": {
    "id": "string",
    "query": "7623828115408274207",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Comment

Tiktok comment. Availability depends on the configured provider route.

Parameters

comment_url

comment_url parameter for this endpoint.

post_url

post_url parameter for this endpoint.

comment_id

comment_id parameter for this endpoint.

parent_comment_id

parent_comment_id parameter for this endpoint.

author_username

author_username parameter for this endpoint.

text_contains

text_contains parameter for this endpoint.

deep_scan

deep_scan parameter for this endpoint.

position_hint

position_hint parameter for this endpoint.

max

max parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/comment
curl -X GET 'https://socialquery.dev/v1/tiktok/comment?comment_url=https%3A%2F%2Fwww.tiktok.com%2F%40mrbeast%2Fvideo%2F7654638524729216287%3Fcomment_id%3D7654640784985211670' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/comment",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/@mrbeast/video/7654638524729216287?comment_id=7654640784985211670",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tiktok search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

region

region parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

limit

limit parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

country

country parameter for this endpoint.

exclude_country

exclude_country parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/search
curl -X GET 'https://socialquery.dev/v1/tiktok/search?query=cooking+recipes' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/search",
  "data": {
    "id": "string",
    "query": "cooking recipes",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tiktok trending. Availability depends on the configured provider route.

Parameters

regionrequired

region parameter for this endpoint.

trim

trim parameter for this endpoint.

feed

feed parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/trending
curl -X GET 'https://socialquery.dev/v1/tiktok/trending?region=US' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/trending",
  "data": {
    "id": "string",
    "query": "US",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Search Hashtag

Tiktok search hashtag. Availability depends on the configured provider route.

Parameters

hashtagrequired

hashtag parameter for this endpoint.

region

region parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/search/hashtag
curl -X GET 'https://socialquery.dev/v1/tiktok/search/hashtag?hashtag=fyp' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/search/hashtag",
  "data": {
    "id": "string",
    "query": "fyp",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Search Top

Tiktok search top. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

publish_time

publish_time parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

region

region parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

country

country parameter for this endpoint.

exclude_country

exclude_country parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/search/top
curl -X GET 'https://socialquery.dev/v1/tiktok/search/top?query=dance+challenge' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/search/top",
  "data": {
    "id": "string",
    "query": "dance challenge",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Search Users

Tiktok search users. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/search/users
curl -X GET 'https://socialquery.dev/v1/tiktok/search/users?query=cooking' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/search/users",
  "data": {
    "id": "string",
    "query": "cooking",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Similar

Tiktok similar. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/similar
curl -X GET 'https://socialquery.dev/v1/tiktok/similar?handle=gordonramsayofficial' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/similar",
  "data": {
    "id": "string",
    "query": "gordonramsayofficial",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok User Audience

Tiktok user audience. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/user/audience
curl -X GET 'https://socialquery.dev/v1/tiktok/user/audience?handle=charlidamelio' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/user/audience",
  "data": {
    "id": "string",
    "query": "charlidamelio",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok User Followers

Tiktok user followers. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

min_time

min_time parameter for this endpoint.

trim

trim parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/user/followers
curl -X GET 'https://socialquery.dev/v1/tiktok/user/followers?handle=stoolpresidente' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/user/followers",
  "data": {
    "id": "string",
    "query": "stoolpresidente",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok User Following

Tiktok user following. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

min_time

min_time parameter for this endpoint.

trim

trim parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/user/following
curl -X GET 'https://socialquery.dev/v1/tiktok/user/following?handle=stoolpresidente' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/user/following",
  "data": {
    "id": "string",
    "query": "stoolpresidente",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok User Live

Tiktok user live. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/user/live
curl -X GET 'https://socialquery.dev/v1/tiktok/user/live?handle=charlidamelio' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/user/live",
  "data": {
    "id": "string",
    "query": "charlidamelio",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Post Transcript

Tiktok post transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

language

language parameter for this endpoint.

use_ai_as_fallback

use_ai_as_fallback parameter for this endpoint.

moments

moments parameter for this endpoint.

brand

brand parameter for this endpoint.

q

q parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/post/transcript
curl -X GET 'https://socialquery.dev/v1/tiktok/post/transcript?url=https%3A%2F%2Fwww.tiktok.com%2F%40stoolpresidente%2Fvideo%2F7499229683859426602' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/post/transcript",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/@stoolpresidente/video/7499229683859426602",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Video Screen Text

Tiktok video screen text. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/video/screen-text
curl -X GET 'https://socialquery.dev/v1/tiktok/video/screen-text?url=https%3A%2F%2Fwww.tiktok.com%2F%40stoolpresidente%2Fvideo%2F7499229683859426602' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/video/screen-text",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/@stoolpresidente/video/7499229683859426602",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Song

Tiktok song. Availability depends on the configured provider route.

Parameters

clipIdrequired

clipId parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/song
curl -X GET 'https://socialquery.dev/v1/tiktok/song?clipId=7439295283975702544' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/song",
  "data": {
    "id": "string",
    "query": "7439295283975702544",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Song Videos

Tiktok song videos. Availability depends on the configured provider route.

Parameters

clipId

clipId parameter for this endpoint.

cursor

cursor parameter for this endpoint.

use

use parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/song/videos
curl -X GET 'https://socialquery.dev/v1/tiktok/song/videos?clipId=7439295283975702544' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/song/videos",
  "data": {
    "id": "string",
    "query": "7439295283975702544",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tiktok hashtags popular. Availability depends on the configured provider route.

Parameters

countryCode

countryCode parameter for this endpoint.

period

period parameter for this endpoint.

industry

industry parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/hashtags/popular
curl -X GET 'https://socialquery.dev/v1/tiktok/hashtags/popular' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/hashtags/popular",
  "data": {
    "id": "string",
    "query": "DE",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 6,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tiktok videos popular. Availability depends on the configured provider route.

Parameters

countryCode

countryCode parameter for this endpoint.

period

period parameter for this endpoint.

orderBy

orderBy parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/videos/popular
curl -X GET 'https://socialquery.dev/v1/tiktok/videos/popular' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/videos/popular",
  "data": {
    "id": "string",
    "query": "US",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 26,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Profile Region

Tiktok profile region. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/profile/region
curl -X GET 'https://socialquery.dev/v1/tiktok/profile/region?handle=stoolpresidente' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/profile/region",
  "data": {
    "id": "string",
    "query": "stoolpresidente",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tiktok adlibrary search. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

advertiser_name

advertiser_name parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/adlibrary/search
curl -X GET 'https://socialquery.dev/v1/tiktok/adlibrary/search?query=ai+agents' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/adlibrary/search",
  "data": {
    "id": "string",
    "query": "ai agents",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Adlibrary Ad

Tiktok adlibrary ad. Availability depends on the configured provider route.

Parameters

ad_id

ad_id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/adlibrary/ad
curl -X GET 'https://socialquery.dev/v1/tiktok/adlibrary/ad?ad_id=1869335220395266' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/adlibrary/ad",
  "data": {
    "id": "string",
    "query": "1869335220395266",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Search Suggestions

Tiktok search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/search/suggestions
curl -X GET 'https://socialquery.dev/v1/tiktok/search/suggestions?query=dogs' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/search/suggestions",
  "data": {
    "id": "string",
    "query": "dogs",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Collection Videos

Tiktok collection videos. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

max_cursor

max_cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/collection/videos
curl -X GET 'https://socialquery.dev/v1/tiktok/collection/videos?url=https%3A%2F%2Fwww.tiktok.com%2F%40kibblemaster808%2Fcollection%2FWant-to-go-7665668414573546258' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/collection/videos",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/@kibblemaster808/collection/Want-to-go-7665668414573546258",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Profile Playlists

Tiktok profile playlists. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/profile/playlists
curl -X GET 'https://socialquery.dev/v1/tiktok/profile/playlists?handle=chipotle' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/profile/playlists",
  "data": {
    "id": "string",
    "query": "chipotle",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Playlist Videos

Tiktok playlist videos. Availability depends on the configured provider route.

Parameters

playlist_idrequired

playlist_id parameter for this endpoint.

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/playlist/videos
curl -X GET 'https://socialquery.dev/v1/tiktok/playlist/videos?playlist_id=7229371484127382314&handle=chipotle' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/playlist/videos",
  "data": {
    "id": "string",
    "query": "7229371484127382314",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok User Liked

Tiktok user liked. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/user/liked
curl -X GET 'https://socialquery.dev/v1/tiktok/user/liked?handle=chipotle' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/user/liked",
  "data": {
    "id": "string",
    "query": "chipotle",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Location Posts

Tiktok location posts. Availability depends on the configured provider route.

Parameters

location_idrequired

location_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

region

region parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/location/posts
curl -X GET 'https://socialquery.dev/v1/tiktok/location/posts?location_id=22535865202815278' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/location/posts",
  "data": {
    "id": "string",
    "query": "22535865202815278",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Effects

Tiktok effects. Availability depends on the configured provider route.

Parameters

idsrequired

ids parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/effects
curl -X GET 'https://socialquery.dev/v1/tiktok/effects?ids=1108584%2C1109028' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/effects",
  "data": {
    "id": "string",
    "query": "1108584,1109028",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Effect Videos

Tiktok effect videos. Availability depends on the configured provider route.

Parameters

effect_idrequired

effect_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

region

region parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/effect/videos
curl -X GET 'https://socialquery.dev/v1/tiktok/effect/videos?effect_id=1108584' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/effect/videos",
  "data": {
    "id": "string",
    "query": "1108584",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Search Music

Tiktok search music. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

filter_by

filter_by parameter for this endpoint.

region

region parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/search/music
curl -X GET 'https://socialquery.dev/v1/tiktok/search/music?query=espresso' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/search/music",
  "data": {
    "id": "string",
    "query": "espresso",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Hashtag

Tiktok hashtag. Availability depends on the configured provider route.

Parameters

hashtag

hashtag parameter for this endpoint.

hashtag_id

hashtag_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/hashtag
curl -X GET 'https://socialquery.dev/v1/tiktok/hashtag?hashtag=kpop' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/hashtag",
  "data": {
    "id": "string",
    "query": "kpop",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Ads Top

Tiktok ads top. Availability depends on the configured provider route.

Parameters

country

country parameter for this endpoint.

period

period parameter for this endpoint.

order_by

order_by parameter for this endpoint.

ad_format

ad_format parameter for this endpoint.

ad_language

ad_language parameter for this endpoint.

like_tier

like_tier parameter for this endpoint.

industry

industry parameter for this endpoint.

keyword

keyword parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/ads/top
curl -X GET 'https://socialquery.dev/v1/tiktok/ads/top' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/ads/top",
  "data": {
    "id": "string",
    "query": "US",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Profile Full

Tiktok profile full. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

posts

posts parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktok/profile/full
curl -X GET 'https://socialquery.dev/v1/tiktok/profile/full?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/profile/full",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "tiktok"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channel

Youtube channel. Availability depends on the configured provider route.

Parameters

channelId

channelId parameter for this endpoint.

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

hl

hl parameter for this endpoint.

forUsername

forUsername parameter for this endpoint.

contact_email

contact_email parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/channel
curl -X GET 'https://socialquery.dev/v1/youtube/channel?channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel",
  "data": {
    "id": "string",
    "query": "UC_x5XG1OV2P6uZZ5FSM9Ttw",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channel About

Youtube channel about. Availability depends on the configured provider route.

Parameters

channelId

channelId parameter for this endpoint.

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

contact_email

contact_email parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/channel/about
curl -X GET 'https://socialquery.dev/v1/youtube/channel/about?channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel/about",
  "data": {
    "id": "string",
    "query": "UC_x5XG1OV2P6uZZ5FSM9Ttw",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 25,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channel Videos

Youtube channel videos. Availability depends on the configured provider route.

Parameters

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

channelId

channelId parameter for this endpoint.

handle

handle parameter for this endpoint.

sort

sort parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

includeExtras

includeExtras parameter for this endpoint.

is_paid_promotions

is_paid_promotions parameter for this endpoint.

include

include parameter for this endpoint.

exact_dates

exact_dates parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/channel/videos
curl -X GET 'https://socialquery.dev/v1/youtube/channel/videos?channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel/videos",
  "data": {
    "id": "string",
    "query": "2026-09-01",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video

Youtube video. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

language

language parameter for this endpoint.

hl

hl parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video
curl -X GET 'https://socialquery.dev/v1/youtube/video?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Videos

Youtube videos. Availability depends on the configured provider route.

Parameters

hl

hl parameter for this endpoint.

idsrequired

ids JSON body field for this endpoint.

include_localizations

include_localizations JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/youtube/videos
curl -X POST 'https://socialquery.dev/v1/youtube/videos' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"ids":["dQw4w9WgXcQ"]}'
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/videos",
  "data": {
    "id": "string",
    "query": "en",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channels

Youtube channels. Availability depends on the configured provider route.

Parameters

hl

hl parameter for this endpoint.

idsrequired

ids JSON body field for this endpoint.

include_localizations

include_localizations JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/youtube/channels
curl -X POST 'https://socialquery.dev/v1/youtube/channels' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"ids":["UCX6OQ3DkcsbYNE6H8uQQuVA"]}'
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channels",
  "data": {
    "id": "string",
    "query": "en",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Transcripts

Youtube transcripts. Availability depends on the configured provider route.

Parameters

idsrequired

ids JSON body field for this endpoint.

language

language JSON body field for this endpoint.

format

format JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/youtube/transcripts
curl -X POST 'https://socialquery.dev/v1/youtube/transcripts' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"ids":["dQw4w9WgXcQ"]}'
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/transcripts",
  "data": {
    "id": "string",
    "query": "[\"dQw4w9WgXcQ\"]",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 3,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Sponsors

Youtube video sponsors. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/sponsors
curl -X GET 'https://socialquery.dev/v1/youtube/video/sponsors?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DAVO0ifle-OU' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/sponsors",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=AVO0ifle-OU",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Comments

Youtube video comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

order

order parameter for this endpoint.

searchTerm

searchTerm parameter for this endpoint.

format

format parameter for this endpoint.

max_results

max_results parameter for this endpoint.

channel_id

channel_id parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/comments
curl -X GET 'https://socialquery.dev/v1/youtube/video/comments?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/comments",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Comment Replies

Youtube video comment replies. Availability depends on the configured provider route.

Parameters

continuationTokenrequired

continuationToken parameter for this endpoint.

format

format parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/comment/replies
curl -X GET 'https://socialquery.dev/v1/youtube/video/comment/replies?continuationToken=Ugzge340dBgB75hWBm54AaABAg' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/comment/replies",
  "data": {
    "id": "string",
    "query": "Ugzge340dBgB75hWBm54AaABAg",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Youtube search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

uploadDate

uploadDate parameter for this endpoint.

sortBy

sortBy parameter for this endpoint.

type

type parameter for this endpoint.

duration

duration parameter for this endpoint.

region

region parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

includeExtras

includeExtras parameter for this endpoint.

include

include parameter for this endpoint.

exact_dates

exact_dates parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/search
curl -X GET 'https://socialquery.dev/v1/youtube/search?query=javascript+tutorial' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/search",
  "data": {
    "id": "string",
    "query": "javascript tutorial",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channel Shorts

Youtube channel shorts. Availability depends on the configured provider route.

Parameters

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

handle

handle parameter for this endpoint.

channelId

channelId parameter for this endpoint.

sort

sort parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

include

include parameter for this endpoint.

exact_dates

exact_dates parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/channel/shorts
curl -X GET 'https://socialquery.dev/v1/youtube/channel/shorts?channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel/shorts",
  "data": {
    "id": "string",
    "query": "2026-09-01",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Community Post

Youtube community post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/community-post
curl -X GET 'https://socialquery.dev/v1/youtube/community-post?url=https%3A%2F%2Fwww.youtube.com%2Fpost%2FUgkxvj2KoApYAXoqLWnKVr6zZe5JjeHrQeP8' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/community-post",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/post/Ugkxvj2KoApYAXoqLWnKVr6zZe5JjeHrQeP8",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Playlist

Youtube playlist. Availability depends on the configured provider route.

Parameters

playlist_idrequired

playlist_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

channel_id

channel_id parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/playlist
curl -X GET 'https://socialquery.dev/v1/youtube/playlist?playlist_id=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/playlist",
  "data": {
    "id": "string",
    "query": "PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Search Hashtag

Youtube search hashtag. Availability depends on the configured provider route.

Parameters

hashtagrequired

hashtag parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

type

type parameter for this endpoint.

include

include parameter for this endpoint.

exact_dates

exact_dates parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/search/hashtag
curl -X GET 'https://socialquery.dev/v1/youtube/search/hashtag?hashtag=shorts' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/search/hashtag",
  "data": {
    "id": "string",
    "query": "shorts",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Youtube shorts trending. Availability depends on the configured provider route.

Parameters

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/shorts/trending
curl -X GET 'https://socialquery.dev/v1/youtube/shorts/trending' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/shorts/trending",
  "data": {
    "id": "string",
    "query": "channel",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Transcript

Youtube video transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

language

language parameter for this endpoint.

moments

moments parameter for this endpoint.

brand

brand parameter for this endpoint.

q

q parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/transcript
curl -X GET 'https://socialquery.dev/v1/youtube/video/transcript?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/transcript",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 3,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channel Playlists

Youtube channel playlists. Availability depends on the configured provider route.

Parameters

channelId

channelId parameter for this endpoint.

handle

handle parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/channel/playlists
curl -X GET 'https://socialquery.dev/v1/youtube/channel/playlists?channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel/playlists",
  "data": {
    "id": "string",
    "query": "UC_x5XG1OV2P6uZZ5FSM9Ttw",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channel Lives

Youtube channel lives. Availability depends on the configured provider route.

Parameters

channelId

channelId parameter for this endpoint.

handle

handle parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

include

include parameter for this endpoint.

exact_dates

exact_dates parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/channel/lives
curl -X GET 'https://socialquery.dev/v1/youtube/channel/lives?channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel/lives",
  "data": {
    "id": "string",
    "query": "UC_x5XG1OV2P6uZZ5FSM9Ttw",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Channel Community Posts

Youtube channel community posts. Availability depends on the configured provider route.

Parameters

channelId

channelId parameter for this endpoint.

handle

handle parameter for this endpoint.

continuationToken

continuationToken parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/channel/community-posts
curl -X GET 'https://socialquery.dev/v1/youtube/channel/community-posts?channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel/community-posts",
  "data": {
    "id": "string",
    "query": "UC_x5XG1OV2P6uZZ5FSM9Ttw",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Youtube videos trending. Availability depends on the configured provider route.

Parameters

region

region parameter for this endpoint.

category

category parameter for this endpoint.

language

language parameter for this endpoint.

max_results

max_results parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/videos/trending
curl -X GET 'https://socialquery.dev/v1/youtube/videos/trending' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/videos/trending",
  "data": {
    "id": "string",
    "query": "US",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Playlist Items

Youtube playlist items. Availability depends on the configured provider route.

Parameters

playlist_idrequired

playlist_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

channel_id

channel_id parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/playlist/items
curl -X GET 'https://socialquery.dev/v1/youtube/playlist/items?playlist_id=PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/playlist/items",
  "data": {
    "id": "string",
    "query": "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Search Advanced

Youtube search advanced. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

order

order parameter for this endpoint.

duration

duration parameter for this endpoint.

event_type

event_type parameter for this endpoint.

license

license parameter for this endpoint.

category

category parameter for this endpoint.

region

region parameter for this endpoint.

language

language parameter for this endpoint.

published_after

published_after parameter for this endpoint.

published_before

published_before parameter for this endpoint.

channel_id

channel_id parameter for this endpoint.

max_results

max_results parameter for this endpoint.

cursor

cursor parameter for this endpoint.

safe_search

safe_search parameter for this endpoint.

video_caption

video_caption parameter for this endpoint.

video_definition

video_definition parameter for this endpoint.

video_dimension

video_dimension parameter for this endpoint.

video_embeddable

video_embeddable parameter for this endpoint.

video_type

video_type parameter for this endpoint.

topic_id

topic_id parameter for this endpoint.

location

location parameter for this endpoint.

location_radius

location_radius parameter for this endpoint.

includeExtras

includeExtras parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/search/advanced
curl -X GET 'https://socialquery.dev/v1/youtube/search/advanced?query=lofi+hip+hop' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/search/advanced",
  "data": {
    "id": "string",
    "query": "lofi hip hop",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Search Suggestions

Youtube search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/search/suggestions
curl -X GET 'https://socialquery.dev/v1/youtube/search/suggestions?query=lofi' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/search/suggestions",
  "data": {
    "id": "string",
    "query": "lofi",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Audio

Youtube video audio. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/audio
curl -X GET 'https://socialquery.dev/v1/youtube/video/audio?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/audio",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Files

Youtube video files. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/files
curl -X GET 'https://socialquery.dev/v1/youtube/video/files?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/files",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Subtitles

Youtube video subtitles. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

format

format parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/subtitles
curl -X GET 'https://socialquery.dev/v1/youtube/video/subtitles?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/subtitles",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Video Thumbnails

Youtube video thumbnails. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/video/thumbnails
curl -X GET 'https://socialquery.dev/v1/youtube/video/thumbnails?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/video/thumbnails",
  "data": {
    "id": "string",
    "query": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

YouTube Profile Full

Youtube profile full. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

channelId

channelId parameter for this endpoint.

url

url parameter for this endpoint.

posts

posts parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/youtube/profile/full
curl -X GET 'https://socialquery.dev/v1/youtube/profile/full?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/profile/full",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "youtube"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Profile

Facebook profile. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

get_business_hours

get_business_hours parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/profile
curl -X GET 'https://socialquery.dev/v1/facebook/profile?url=https%3A%2F%2Fwww.facebook.com%2FMeta' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/profile",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/Meta",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Profile Posts

Facebook profile posts. Availability depends on the configured provider route.

Parameters

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

url

url parameter for this endpoint.

pageId

pageId parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

recent_days

recent_days parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/profile/posts
curl -X GET 'https://socialquery.dev/v1/facebook/profile/posts?url=https%3A%2F%2Fwww.facebook.com%2FMeta' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/profile/posts",
  "data": {
    "id": "string",
    "query": "2026-09-01",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Post

Facebook post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

get_comments

get_comments parameter for this endpoint.

get_transcript

get_transcript parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/post
curl -X GET 'https://socialquery.dev/v1/facebook/post?url=https%3A%2F%2Fwww.facebook.com%2FMeta%2Fposts%2F1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/post",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/Meta/posts/1234567890",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Post Comments

Facebook post comments. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

feedback_id

feedback_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/post/comments
curl -X GET 'https://socialquery.dev/v1/facebook/post/comments?url=https%3A%2F%2Fwww.facebook.com%2FMeta%2Fvideos%2Fa-slightly-life-changing-story%2F1459847961114516%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/Meta/videos/a-slightly-life-changing-story/1459847961114516/",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Group Posts

Facebook group posts. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

group_id

group_id parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/group/posts
curl -X GET 'https://socialquery.dev/v1/facebook/group/posts?url=https%3A%2F%2Fwww.facebook.com%2Fgroups%2F2204685680' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/group/posts",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/groups/2204685680",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Group

Facebook group. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

group_id

group_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/group
curl -X GET 'https://socialquery.dev/v1/facebook/group?url=https%3A%2F%2Fwww.facebook.com%2Fgroups%2F2204685680' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/group",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/groups/2204685680",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Post Transcript

Facebook post transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/post/transcript
curl -X GET 'https://socialquery.dev/v1/facebook/post/transcript?url=https%3A%2F%2Fwww.facebook.com%2FMeta%2Fvideos%2Fa-slightly-life-changing-story%2F1459847961114516%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/post/transcript",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/Meta/videos/a-slightly-life-changing-story/1459847961114516/",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Profile Photos

Facebook profile photos. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

next_page_id

next_page_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/profile/photos
curl -X GET 'https://socialquery.dev/v1/facebook/profile/photos?url=https%3A%2F%2Fwww.facebook.com%2FMeta' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/profile/photos",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/Meta",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Profile Reels

Facebook profile reels. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

next_page_id

next_page_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

recent_days

recent_days parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/profile/reels
curl -X GET 'https://socialquery.dev/v1/facebook/profile/reels?url=https%3A%2F%2Fwww.facebook.com%2FMeta' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/profile/reels",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/Meta",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Adlibrary Ad

Facebook adlibrary ad. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

trim

trim parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/adlibrary/ad
curl -X GET 'https://socialquery.dev/v1/facebook/adlibrary/ad?id=1702938977100376' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/adlibrary/ad",
  "data": {
    "id": "string",
    "query": "1702938977100376",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Adlibrary Company Ads

Facebook adlibrary company ads. Availability depends on the configured provider route.

Parameters

pageId

pageId parameter for this endpoint.

companyName

companyName parameter for this endpoint.

country

country parameter for this endpoint.

status

status parameter for this endpoint.

media_type

media_type parameter for this endpoint.

language

language parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/adlibrary/company/ads
curl -X GET 'https://socialquery.dev/v1/facebook/adlibrary/company/ads?pageId=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/adlibrary/company/ads",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Adlibrary Search Ads

Facebook adlibrary search ads. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

search_type

search_type parameter for this endpoint.

ad_type

ad_type parameter for this endpoint.

country

country parameter for this endpoint.

status

status parameter for this endpoint.

media_type

media_type parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/adlibrary/search/ads
curl -X GET 'https://socialquery.dev/v1/facebook/adlibrary/search/ads?query=artificial+intelligence' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/adlibrary/search/ads",
  "data": {
    "id": "string",
    "query": "artificial intelligence",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Adlibrary Search Companies

Facebook adlibrary search companies. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/adlibrary/search/companies
curl -X GET 'https://socialquery.dev/v1/facebook/adlibrary/search/companies?query=Nike' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/adlibrary/search/companies",
  "data": {
    "id": "string",
    "query": "Nike",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Profile Events

Facebook profile events. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/profile/events
curl -X GET 'https://socialquery.dev/v1/facebook/profile/events?url=https%3A%2F%2Fwww.facebook.com%2Fbrickyardoldtown' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/profile/events",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/brickyardoldtown",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Post Comment Replies

Facebook post comment replies. Availability depends on the configured provider route.

Parameters

feedback_idrequired

feedback_id parameter for this endpoint.

expansion_tokenrequired

expansion_token parameter for this endpoint.

cursor

cursor parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/post/comment/replies
curl -X GET 'https://socialquery.dev/v1/facebook/post/comment/replies?feedback_id=ZmVlZGJhY2s6MzM3MzYxMzI5OTQ4Nzc1NV8xOTI5NTk0OTE3Njg3MTcz&expansion_token=MjoxNzc4NjM1MDM3OgF_JaMa3kMP9RIWC' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/post/comment/replies",
  "data": {
    "id": "string",
    "query": "ZmVlZGJhY2s6MzM3MzYxMzI5OTQ4Nzc1NV8xOTI5NTk0OTE3Njg3MTcz",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook marketplace location search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/marketplace/location/search
curl -X GET 'https://socialquery.dev/v1/facebook/marketplace/location/search?query=Los+Angeles' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/marketplace/location/search",
  "data": {
    "id": "string",
    "query": "Los Angeles",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook marketplace search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

latrequired

lat parameter for this endpoint.

lngrequired

lng parameter for this endpoint.

radius_km

radius_km parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

count

count parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

delivery_method

delivery_method parameter for this endpoint.

condition

condition parameter for this endpoint.

date_listed

date_listed parameter for this endpoint.

availability

availability parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/marketplace/search
curl -X GET 'https://socialquery.dev/v1/facebook/marketplace/search?query=bike&lat=40.7128&lng=-74.0060' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/marketplace/search",
  "data": {
    "id": "string",
    "query": "bike",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Marketplace Item

Facebook marketplace item. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/marketplace/item
curl -X GET 'https://socialquery.dev/v1/facebook/marketplace/item?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/marketplace/item",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook events search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/events/search
curl -X GET 'https://socialquery.dev/v1/facebook/events/search?query=dogs' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/events/search",
  "data": {
    "id": "string",
    "query": "dogs",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Events

Facebook events. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

time

time parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/events
curl -X GET 'https://socialquery.dev/v1/facebook/events?url=https%3A%2F%2Fwww.facebook.com%2Fevents%2Fexplore%2Fsaint-petersburg-florida%2F111326725552547' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/events",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Event Details

Facebook event details. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/event/details
curl -X GET 'https://socialquery.dev/v1/facebook/event/details?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/event/details",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Adlibrary Ad Transcript

Facebook adlibrary ad transcript. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/adlibrary/ad/transcript
curl -X GET 'https://socialquery.dev/v1/facebook/adlibrary/ad/transcript?id=1702938977100376' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/adlibrary/ad/transcript",
  "data": {
    "id": "string",
    "query": "1702938977100376",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Profile Full

Facebook profile full. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

posts

posts parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/profile/full
curl -X GET 'https://socialquery.dev/v1/facebook/profile/full?url=https%3A%2F%2Fwww.facebook.com%2Fmrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/profile/full",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/mrbeast",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Profile Reels Full

Facebook profile reels full. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/profile/reels/full
curl -X GET 'https://socialquery.dev/v1/facebook/profile/reels/full?url=https%3A%2F%2Fwww.facebook.com%2FMeta' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/profile/reels/full",
  "data": {
    "id": "string",
    "query": "https://www.facebook.com/Meta",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Search Posts

Facebook search posts. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

recent_posts

recent_posts parameter for this endpoint.

location_uid

location_uid parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/search/posts
curl -X GET 'https://socialquery.dev/v1/facebook/search/posts?query=NASA' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/search/posts",
  "data": {
    "id": "string",
    "query": "NASA",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Search Pages

Facebook search pages. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

location_uid

location_uid parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/search/pages
curl -X GET 'https://socialquery.dev/v1/facebook/search/pages?query=NASA' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/search/pages",
  "data": {
    "id": "string",
    "query": "NASA",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Search People

Facebook search people. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

location_uid

location_uid parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/search/people
curl -X GET 'https://socialquery.dev/v1/facebook/search/people?query=NASA' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/search/people",
  "data": {
    "id": "string",
    "query": "NASA",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Search Videos

Facebook search videos. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

recent_videos

recent_videos parameter for this endpoint.

location_uid

location_uid parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/search/videos
curl -X GET 'https://socialquery.dev/v1/facebook/search/videos?query=NASA' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/search/videos",
  "data": {
    "id": "string",
    "query": "NASA",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Facebook Search Groups

Facebook search groups. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

include

include parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/facebook/search/groups
curl -X GET 'https://socialquery.dev/v1/facebook/search/groups?query=vintage+cars' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "facebook",
  "endpoint": "/v1/facebook/search/groups",
  "data": {
    "id": "string",
    "query": "vintage cars",
    "status": "ok",
    "source": "facebook"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Scrape

Web scrape. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

formats

formats parameter for this endpoint.

only_main_content

only_main_content parameter for this endpoint.

wait_for

wait_for parameter for this endpoint.

mobile

mobile parameter for this endpoint.

timeout

timeout parameter for this endpoint.

max_age

max_age parameter for this endpoint.

location_country

location_country parameter for this endpoint.

screenshot_full_page

screenshot_full_page parameter for this endpoint.

include_tags

include_tags parameter for this endpoint.

exclude_tags

exclude_tags parameter for this endpoint.

proxy

proxy parameter for this endpoint.

pdf_parse

pdf_parse parameter for this endpoint.

block_ads

block_ads parameter for this endpoint.

remove_base64_images

remove_base64_images parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/scrape
curl -X GET 'https://socialquery.dev/v1/web/scrape?url=https%3A%2F%2Fexample.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/scrape",
  "data": {
    "id": "string",
    "query": "https://example.com",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sources

sources parameter for this endpoint.

categories

categories parameter for this endpoint.

limit

limit parameter for this endpoint.

country

country parameter for this endpoint.

location

location parameter for this endpoint.

time_range

time_range parameter for this endpoint.

sort_by_date

sort_by_date parameter for this endpoint.

include_domains

include_domains parameter for this endpoint.

exclude_domains

exclude_domains parameter for this endpoint.

include_content

include_content parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/search
curl -X GET 'https://socialquery.dev/v1/web/search?query=social+media+data+api' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/search",
  "data": {
    "id": "string",
    "query": "social media data api",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Map

Web map. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

search

search parameter for this endpoint.

limit

limit parameter for this endpoint.

sitemap

sitemap parameter for this endpoint.

include_subdomains

include_subdomains parameter for this endpoint.

ignore_query_parameters

ignore_query_parameters parameter for this endpoint.

fresh

fresh parameter for this endpoint.

goal

goal parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/map
curl -X GET 'https://socialquery.dev/v1/web/map?url=https%3A%2F%2Fexample.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/map",
  "data": {
    "id": "string",
    "query": "https://example.com",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Extract

Web extract. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

schema

schema parameter for this endpoint.

prompt

prompt parameter for this endpoint.

only_main_content

only_main_content parameter for this endpoint.

timeout

timeout parameter for this endpoint.

max_age

max_age parameter for this endpoint.

proxy

proxy parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/extract
curl -X GET 'https://socialquery.dev/v1/web/extract?url=https%3A%2F%2Fexample.com%2Fpricing' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/extract",
  "data": {
    "id": "string",
    "query": "https://example.com/pricing",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Crawl

Web crawl. Availability depends on the configured provider route.

Parameters

urlrequired

url JSON body field for this endpoint.

limit

limit JSON body field for this endpoint.

max_depth

max_depth JSON body field for this endpoint.

allow_backward_links

allow_backward_links JSON body field for this endpoint.

allow_external_links

allow_external_links JSON body field for this endpoint.

include_paths

include_paths JSON body field for this endpoint.

exclude_paths

exclude_paths JSON body field for this endpoint.

webhook_url

webhook_url JSON body field for this endpoint.

formats

formats JSON body field for this endpoint.

goal

goal JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/web/crawl
curl -X POST 'https://socialquery.dev/v1/web/crawl' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com/post"}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/crawl",
  "data": {
    "id": "string",
    "query": "https://example.com/post",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Batch Scrape

Web batch scrape. Availability depends on the configured provider route.

Parameters

urlsrequired

urls JSON body field for this endpoint.

ignore_invalid_urls

ignore_invalid_urls JSON body field for this endpoint.

formats

formats JSON body field for this endpoint.

only_main_content

only_main_content JSON body field for this endpoint.

proxy

proxy JSON body field for this endpoint.

webhook_url

webhook_url JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/web/batch-scrape
curl -X POST 'https://socialquery.dev/v1/web/batch-scrape' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"urls":["https://news.ycombinator.com/item?id=8863"]}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/batch-scrape",
  "data": {
    "id": "string",
    "query": "[\"https://news.ycombinator.com/item?id=8863\"]",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Jobs

Web jobs. Availability depends on the configured provider route.

Parameters

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/jobs
curl -X GET 'https://socialquery.dev/v1/web/jobs' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/jobs",
  "data": {
    "id": "string",
    "query": "20",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Jobs {Job Id}

Web jobs {job id}. Availability depends on the configured provider route.

Parameters

job_idrequired

job_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/jobs/{job_id}
curl -X GET 'https://socialquery.dev/v1/web/jobs/job_9f3k2n8d1' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/jobs/{job_id}",
  "data": {
    "id": "string",
    "query": "job_9f3k2n8d1",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Jobs {Job Id}

Web jobs {job id}. Availability depends on the configured provider route.

Parameters

job_idrequired

job_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

DELETE/v1/web/jobs/{job_id}
curl -X DELETE 'https://socialquery.dev/v1/web/jobs/job_9f3k2n8d1' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/jobs/{job_id}",
  "data": {
    "id": "string",
    "query": "job_9f3k2n8d1",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Agent

Web agent. Availability depends on the configured provider route.

Parameters

urlrequired

url JSON body field for this endpoint.

promptrequired

prompt JSON body field for this endpoint.

model

model JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/web/agent
curl -X POST 'https://socialquery.dev/v1/web/agent' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com/post"}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/agent",
  "data": {
    "id": "string",
    "query": "https://example.com/post",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 25,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Monitors

Web monitors. Availability depends on the configured provider route.

Parameters

urlrequired

url JSON body field for this endpoint.

name

name JSON body field for this endpoint.

mode

mode JSON body field for this endpoint.

cadence_minutes

cadence_minutes JSON body field for this endpoint.

schedule_text

schedule_text JSON body field for this endpoint.

schedule_cron

schedule_cron JSON body field for this endpoint.

timezone

timezone JSON body field for this endpoint.

webhook_url

webhook_url JSON body field for this endpoint.

query

query JSON body field for this endpoint.

goal

goal JSON body field for this endpoint.

retention_days

retention_days JSON body field for this endpoint.

judge_enabled

judge_enabled JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/web/monitors
curl -X POST 'https://socialquery.dev/v1/web/monitors' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com/post"}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/monitors",
  "data": {
    "id": "string",
    "query": "https://example.com/post",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Monitors

Web monitors. Availability depends on the configured provider route.

Parameters

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/monitors
curl -X GET 'https://socialquery.dev/v1/web/monitors' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/monitors",
  "data": {
    "id": "string",
    "query": "",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Monitors {Monitor Id}

Web monitors {monitor id}. Availability depends on the configured provider route.

Parameters

monitor_idrequired

monitor_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/monitors/{monitor_id}
curl -X GET 'https://socialquery.dev/v1/web/monitors/wm_5d1p8s3k7' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/monitors/{monitor_id}",
  "data": {
    "id": "string",
    "query": "wm_5d1p8s3k7",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Monitors {Monitor Id}

Web monitors {monitor id}. Availability depends on the configured provider route.

Parameters

monitor_idrequired

monitor_id parameter for this endpoint.

status

status JSON body field for this endpoint.

cadence_minutes

cadence_minutes JSON body field for this endpoint.

schedule_text

schedule_text JSON body field for this endpoint.

schedule_cron

schedule_cron JSON body field for this endpoint.

timezone

timezone JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

PATCH/v1/web/monitors/{monitor_id}
curl -X PATCH 'https://socialquery.dev/v1/web/monitors/wm_5d1p8s3k7' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/monitors/{monitor_id}",
  "data": {
    "id": "string",
    "query": "wm_5d1p8s3k7",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Monitors {Monitor Id}

Web monitors {monitor id}. Availability depends on the configured provider route.

Parameters

monitor_idrequired

monitor_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

DELETE/v1/web/monitors/{monitor_id}
curl -X DELETE 'https://socialquery.dev/v1/web/monitors/wm_5d1p8s3k7' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/monitors/{monitor_id}",
  "data": {
    "id": "string",
    "query": "wm_5d1p8s3k7",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Monitors {Monitor Id} Checks

Web monitors {monitor id} checks. Availability depends on the configured provider route.

Parameters

monitor_idrequired

monitor_id parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/monitors/{monitor_id}/checks
curl -X GET 'https://socialquery.dev/v1/web/monitors/wm_5d1p8s3k7/checks' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/monitors/{monitor_id}/checks",
  "data": {
    "id": "string",
    "query": "wm_5d1p8s3k7",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Sessions

Web sessions. Availability depends on the configured provider route.

Parameters

urlrequired

url JSON body field for this endpoint.

ttl_seconds

ttl_seconds JSON body field for this endpoint.

activity_ttl_seconds

activity_ttl_seconds JSON body field for this endpoint.

stream_web_view

stream_web_view JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/web/sessions
curl -X POST 'https://socialquery.dev/v1/web/sessions' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com/post"}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/sessions",
  "data": {
    "id": "string",
    "query": "https://example.com/post",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Sessions

Web sessions. Availability depends on the configured provider route.

Parameters

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/sessions
curl -X GET 'https://socialquery.dev/v1/web/sessions' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/sessions",
  "data": {
    "id": "string",
    "query": "20",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Sessions {Session Id}

Web sessions {session id}. Availability depends on the configured provider route.

Parameters

session_idrequired

session_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/web/sessions/{session_id}
curl -X GET 'https://socialquery.dev/v1/web/sessions/ws_3g7x1v5m2' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/sessions/{session_id}",
  "data": {
    "id": "string",
    "query": "ws_3g7x1v5m2",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Sessions {Session Id}

Web sessions {session id}. Availability depends on the configured provider route.

Parameters

session_idrequired

session_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

DELETE/v1/web/sessions/{session_id}
curl -X DELETE 'https://socialquery.dev/v1/web/sessions/ws_3g7x1v5m2' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/sessions/{session_id}",
  "data": {
    "id": "string",
    "query": "ws_3g7x1v5m2",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Sessions {Session Id} Execute

Web sessions {session id} execute. Availability depends on the configured provider route.

Parameters

session_idrequired

session_id parameter for this endpoint.

coderequired

code JSON body field for this endpoint.

language

language JSON body field for this endpoint.

timeout

timeout JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/web/sessions/{session_id}/execute
curl -X POST 'https://socialquery.dev/v1/web/sessions/ws_3g7x1v5m2/execute' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/sessions/{session_id}/execute",
  "data": {
    "id": "string",
    "query": "ws_3g7x1v5m2",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Web Parse

Web parse. Availability depends on the configured provider route.

Parameters

filerequired

file JSON body field for this endpoint.

filename

filename JSON body field for this endpoint.

mime_type

mime_type JSON body field for this endpoint.

url

url JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/web/parse
curl -X POST 'https://socialquery.dev/v1/web/parse' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
200401
Response example
{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/parse",
  "data": {
    "id": "string",
    "query": "",
    "status": "ok",
    "source": "web"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Trades

Us Congress Trades trades. Availability depends on the configured provider route.

Parameters

ticker

ticker parameter for this endpoint.

politician

politician parameter for this endpoint.

party

party parameter for this endpoint.

chamber

chamber parameter for this endpoint.

sector

sector parameter for this endpoint.

tx_type

tx_type parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

sort

sort parameter for this endpoint.

order

order parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/trades
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/trades' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/trades",
  "data": {
    "id": "string",
    "query": "NVDA",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Trades Latest

Us Congress Trades trades latest. Availability depends on the configured provider route.

Parameters

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/trades/latest
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/trades/latest' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/trades/latest",
  "data": {
    "id": "string",
    "query": "20",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Trades Recent

Us Congress Trades trades recent. Availability depends on the configured provider route.

Parameters

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/trades/recent
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/trades/recent' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/trades/recent",
  "data": {
    "id": "string",
    "query": "20",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Members

Us Congress Trades members. Availability depends on the configured provider route.

Parameters

party

party parameter for this endpoint.

state

state parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/members
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/members' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/members",
  "data": {
    "id": "string",
    "query": "democrat",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Politician

Us Congress Trades politician. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/politician
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/politician?handle=Pelosi' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/politician",
  "data": {
    "id": "string",
    "query": "Pelosi",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Politician Trades

Us Congress Trades politician trades. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

sort

sort parameter for this endpoint.

order

order parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/politician/trades
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/politician/trades?handle=Pelosi' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/politician/trades",
  "data": {
    "id": "string",
    "query": "Pelosi",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Ticker

Us Congress Trades ticker. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/ticker
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/ticker?keyword=AAPL' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/ticker",
  "data": {
    "id": "string",
    "query": "AAPL",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Ticker Trades

Us Congress Trades ticker trades. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

chamber

chamber parameter for this endpoint.

party

party parameter for this endpoint.

tx_type

tx_type parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/ticker/trades
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/ticker/trades?keyword=NVDA' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/ticker/trades",
  "data": {
    "id": "string",
    "query": "NVDA",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades State Trades

Us Congress Trades state trades. Availability depends on the configured provider route.

Parameters

staterequired

state parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/state/trades
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/state/trades?state=ca' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/state/trades",
  "data": {
    "id": "string",
    "query": "ca",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats

Us Congress Trades stats. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats",
  "data": {
    "id": "string",
    "query": "/v1/us_congress_trades/stats",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Party

Us Congress Trades stats party. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/party
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/party' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/party",
  "data": {
    "id": "string",
    "query": "/v1/us_congress_trades/stats/party",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Sectors

Us Congress Trades stats sectors. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/sectors
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/sectors' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/sectors",
  "data": {
    "id": "string",
    "query": "/v1/us_congress_trades/stats/sectors",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Issuers

Us Congress Trades stats issuers. Availability depends on the configured provider route.

Parameters

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/issuers
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/issuers' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/issuers",
  "data": {
    "id": "string",
    "query": "10",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Politicians

Us Congress Trades stats politicians. Availability depends on the configured provider route.

Parameters

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/politicians
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/politicians' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/politicians",
  "data": {
    "id": "string",
    "query": "10",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Tickers

Us Congress Trades stats tickers. Availability depends on the configured provider route.

Parameters

tx_type

tx_type parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/tickers
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/tickers' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/tickers",
  "data": {
    "id": "string",
    "query": "buy",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Volume

Us Congress Trades stats volume. Availability depends on the configured provider route.

Parameters

days

days parameter for this endpoint.

period

period parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/volume
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/volume' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/volume",
  "data": {
    "id": "string",
    "query": "90",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Unusual

Us Congress Trades stats unusual. Availability depends on the configured provider route.

Parameters

days

days parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/unusual
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/unusual' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/unusual",
  "data": {
    "id": "string",
    "query": "30",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Buy Sell

Us Congress Trades stats buy sell. Availability depends on the configured provider route.

Parameters

days

days parameter for this endpoint.

party

party parameter for this endpoint.

sector

sector parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/buy-sell
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/buy-sell' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/buy-sell",
  "data": {
    "id": "string",
    "query": "90",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Us Congress Trades Stats Reporting Gaps

Us Congress Trades stats reporting gaps. Availability depends on the configured provider route.

Parameters

chamber

chamber parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/us_congress_trades/stats/reporting-gaps
curl -X GET 'https://socialquery.dev/v1/us_congress_trades/stats/reporting-gaps' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "us_congress_trades",
  "endpoint": "/v1/us_congress_trades/stats/reporting-gaps",
  "data": {
    "id": "string",
    "query": "senate",
    "status": "ok",
    "source": "us_congress_trades"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Product

Klarna product. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

category_id

category_id parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/product
curl -X GET 'https://socialquery.dev/v1/klarna/product?product_id=3331931731' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/product",
  "data": {
    "id": "string",
    "query": "3331931731",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Product Offers

Klarna product offers. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/product/offers
curl -X GET 'https://socialquery.dev/v1/klarna/product/offers?product_id=3331931731' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/product/offers",
  "data": {
    "id": "string",
    "query": "3331931731",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/search
curl -X GET 'https://socialquery.dev/v1/klarna/search?query=headphone' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/search",
  "data": {
    "id": "string",
    "query": "headphone",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Search Suggestions

Klarna search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/search/suggestions
curl -X GET 'https://socialquery.dev/v1/klarna/search/suggestions?query=headphone' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/search/suggestions",
  "data": {
    "id": "string",
    "query": "headphone",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Reviews

Klarna reviews. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

region

region parameter for this endpoint.

limit

limit parameter for this endpoint.

nextBatchId

nextBatchId parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/reviews
curl -X GET 'https://socialquery.dev/v1/klarna/reviews?product_id=3331931731' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/reviews",
  "data": {
    "id": "string",
    "query": "3331931731",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Reviews Pro

Klarna reviews pro. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

region

region parameter for this endpoint.

limit

limit parameter for this endpoint.

nextBatchId

nextBatchId parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/reviews/pro
curl -X GET 'https://socialquery.dev/v1/klarna/reviews/pro?product_id=3331931731' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/reviews/pro",
  "data": {
    "id": "string",
    "query": "3331931731",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Reviews Overview

Klarna reviews overview. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/reviews/overview
curl -X GET 'https://socialquery.dev/v1/klarna/reviews/overview?product_id=3331931731' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/reviews/overview",
  "data": {
    "id": "string",
    "query": "3331931731",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Product Price History

Klarna product price history. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

region

region parameter for this endpoint.

interval

interval parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/product/price-history
curl -X GET 'https://socialquery.dev/v1/klarna/product/price-history?product_id=3331931731' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/product/price-history",
  "data": {
    "id": "string",
    "query": "3331931731",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Product Compare

Klarna product compare. Availability depends on the configured provider route.

Parameters

product_idrequired

product_id parameter for this endpoint.

product_id_2required

product_id_2 parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/product/compare
curl -X GET 'https://socialquery.dev/v1/klarna/product/compare?product_id=3331931731&product_id_2=3216399795' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/product/compare",
  "data": {
    "id": "string",
    "query": "3331931731",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Category

Klarna category. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

region

region parameter for this endpoint.

size

size parameter for this endpoint.

offset

offset parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

price_range

price_range parameter for this endpoint.

filter

filter parameter for this endpoint.

category_path_id

category_path_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/category
curl -X GET 'https://socialquery.dev/v1/klarna/category?category_id=cl94' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/category",
  "data": {
    "id": "string",
    "query": "cl94",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Categories

Klarna categories. Availability depends on the configured provider route.

Parameters

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/categories
curl -X GET 'https://socialquery.dev/v1/klarna/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/categories",
  "data": {
    "id": "string",
    "query": "usa",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Categories Children

Klarna categories children. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/categories/children
curl -X GET 'https://socialquery.dev/v1/klarna/categories/children?category_id=t1' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/categories/children",
  "data": {
    "id": "string",
    "query": "t1",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Category Filters

Klarna category filters. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

region

region parameter for this endpoint.

category_path_id

category_path_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/category/filters
curl -X GET 'https://socialquery.dev/v1/klarna/category/filters?category_id=cl94' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/category/filters",
  "data": {
    "id": "string",
    "query": "cl94",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Category Keywords

Klarna category keywords. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/category/keywords
curl -X GET 'https://socialquery.dev/v1/klarna/category/keywords?category_id=t1' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/category/keywords",
  "data": {
    "id": "string",
    "query": "t1",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Category Guide

Klarna category guide. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

region

region parameter for this endpoint.

size

size parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/category/guide
curl -X GET 'https://socialquery.dev/v1/klarna/category/guide?category_id=cl94' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/category/guide",
  "data": {
    "id": "string",
    "query": "cl94",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Stores

Klarna stores. Availability depends on the configured provider route.

Parameters

region

region parameter for this endpoint.

size

size parameter for this endpoint.

offset

offset parameter for this endpoint.

categories

categories parameter for this endpoint.

cashback

cashback parameter for this endpoint.

shop_in_app

shop_in_app parameter for this endpoint.

klarna_at_checkout

klarna_at_checkout parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/stores
curl -X GET 'https://socialquery.dev/v1/klarna/stores' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/stores",
  "data": {
    "id": "string",
    "query": "usa",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Store Products

Klarna store products. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

region

region parameter for this endpoint.

size

size parameter for this endpoint.

offset

offset parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

price_range

price_range parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/store/products
curl -X GET 'https://socialquery.dev/v1/klarna/store/products?id=09f4d635-0452-4f63-9455-c45420d95669' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/store/products",
  "data": {
    "id": "string",
    "query": "09f4d635-0452-4f63-9455-c45420d95669",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Klarna Store Filters

Klarna store filters. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/klarna/store/filters
curl -X GET 'https://socialquery.dev/v1/klarna/store/filters?id=09f4d635-0452-4f63-9455-c45420d95669' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "klarna",
  "endpoint": "/v1/klarna/store/filters",
  "data": {
    "id": "string",
    "query": "09f4d635-0452-4f63-9455-c45420d95669",
    "status": "ok",
    "source": "klarna"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor search. Availability depends on the configured provider route.

Parameters

qrequired

q parameter for this endpoint.

location

location parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/search
curl -X GET 'https://socialquery.dev/v1/tripadvisor/search?q=pizza+restaurant' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/search",
  "data": {
    "id": "string",
    "query": "pizza restaurant",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Reviews

Tripadvisor reviews. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

depth

depth parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

rating

rating parameter for this endpoint.

visit_type

visit_type parameter for this endpoint.

search_reviews_keyword

search_reviews_keyword parameter for this endpoint.

translate

translate parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/reviews
curl -X GET 'https://socialquery.dev/v1/tripadvisor/reviews?url_path=Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/reviews",
  "data": {
    "id": "string",
    "query": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Place

Tripadvisor place. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

language

language parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/place
curl -X GET 'https://socialquery.dev/v1/tripadvisor/place?url_path=Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/place",
  "data": {
    "id": "string",
    "query": "Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Autocomplete

Tripadvisor autocomplete. Availability depends on the configured provider route.

Parameters

qrequired

q parameter for this endpoint.

depth

depth parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/autocomplete
curl -X GET 'https://socialquery.dev/v1/tripadvisor/autocomplete?q=Paris' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/autocomplete",
  "data": {
    "id": "string",
    "query": "Paris",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Hotels

Tripadvisor hotels. Availability depends on the configured provider route.

Parameters

qrequired

q parameter for this endpoint.

depth

depth parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

price_min

price_min parameter for this endpoint.

price_max

price_max parameter for this endpoint.

star_rating_min

star_rating_min parameter for this endpoint.

review_score_min

review_score_min parameter for this endpoint.

property_type

property_type parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/hotels
curl -X GET 'https://socialquery.dev/v1/tripadvisor/hotels?q=Paris' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/hotels",
  "data": {
    "id": "string",
    "query": "Paris",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Hotel

Tripadvisor hotel. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

language

language parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/hotel
curl -X GET 'https://socialquery.dev/v1/tripadvisor/hotel?url_path=Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/hotel",
  "data": {
    "id": "string",
    "query": "Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Restaurants

Tripadvisor restaurants. Availability depends on the configured provider route.

Parameters

qrequired

q parameter for this endpoint.

depth

depth parameter for this endpoint.

cuisine

cuisine parameter for this endpoint.

meal_type

meal_type parameter for this endpoint.

price_level

price_level parameter for this endpoint.

dietary_restriction

dietary_restriction parameter for this endpoint.

open_now

open_now parameter for this endpoint.

online_reservations

online_reservations parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/restaurants
curl -X GET 'https://socialquery.dev/v1/tripadvisor/restaurants?q=Paris' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/restaurants",
  "data": {
    "id": "string",
    "query": "Paris",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Restaurant

Tripadvisor restaurant. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

language

language parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/restaurant
curl -X GET 'https://socialquery.dev/v1/tripadvisor/restaurant?url_path=Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/restaurant",
  "data": {
    "id": "string",
    "query": "Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Restaurant Reviews

Tripadvisor restaurant reviews. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

depth

depth parameter for this endpoint.

language

language parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/restaurant/reviews
curl -X GET 'https://socialquery.dev/v1/tripadvisor/restaurant/reviews?url_path=Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/restaurant/reviews",
  "data": {
    "id": "string",
    "query": "Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Attractions

Tripadvisor attractions. Availability depends on the configured provider route.

Parameters

qrequired

q parameter for this endpoint.

depth

depth parameter for this endpoint.

category

category parameter for this endpoint.

duration

duration parameter for this endpoint.

traveler_rating

traveler_rating parameter for this endpoint.

free_cancellation

free_cancellation parameter for this endpoint.

skip_the_line

skip_the_line parameter for this endpoint.

private_tour

private_tour parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/attractions
curl -X GET 'https://socialquery.dev/v1/tripadvisor/attractions?q=Bangkok' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/attractions",
  "data": {
    "id": "string",
    "query": "Bangkok",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Attraction

Tripadvisor attraction. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

language

language parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/attraction
curl -X GET 'https://socialquery.dev/v1/tripadvisor/attraction?url_path=Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/attraction",
  "data": {
    "id": "string",
    "query": "Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Attraction Reviews

Tripadvisor attraction reviews. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

depth

depth parameter for this endpoint.

language

language parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/attraction/reviews
curl -X GET 'https://socialquery.dev/v1/tripadvisor/attraction/reviews?url_path=Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/attraction/reviews",
  "data": {
    "id": "string",
    "query": "Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Experience Types

Tripadvisor experience types. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/experience-types
curl -X GET 'https://socialquery.dev/v1/tripadvisor/experience-types?query=Bangkok' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/experience-types",
  "data": {
    "id": "string",
    "query": "Bangkok",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Cruises

Tripadvisor cruises. Availability depends on the configured provider route.

Parameters

qrequired

q parameter for this endpoint.

depth

depth parameter for this endpoint.

departure_month

departure_month parameter for this endpoint.

cabin_type

cabin_type parameter for this endpoint.

length

length parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/cruises
curl -X GET 'https://socialquery.dev/v1/tripadvisor/cruises?q=Caribbean' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/cruises",
  "data": {
    "id": "string",
    "query": "Caribbean",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Cruise

Tripadvisor cruise. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

language

language parameter for this endpoint.

currency

currency parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/cruise
curl -X GET 'https://socialquery.dev/v1/tripadvisor/cruise?url_path=Cruise_Review-d15691642-Reviews-MSC_Seaside' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/cruise",
  "data": {
    "id": "string",
    "query": "Cruise_Review-d15691642-Reviews-MSC_Seaside",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tripadvisor Cruise Reviews

Tripadvisor cruise reviews. Availability depends on the configured provider route.

Parameters

url_pathrequired

url_path parameter for this endpoint.

depth

depth parameter for this endpoint.

language

language parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tripadvisor/cruise/reviews
curl -X GET 'https://socialquery.dev/v1/tripadvisor/cruise/reviews?url_path=Cruise_Review-d15691642-Reviews-MSC_Seaside' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tripadvisor",
  "endpoint": "/v1/tripadvisor/cruise/reviews",
  "data": {
    "id": "string",
    "query": "Cruise_Review-d15691642-Reviews-MSC_Seaside",
    "status": "ok",
    "source": "tripadvisor"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Profile

Twitter profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/profile
curl -X GET 'https://socialquery.dev/v1/twitter/profile?handle=elonmusk' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/profile",
  "data": {
    "id": "string",
    "query": "elonmusk",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) User Tweets

Twitter user tweets. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

trim

trim parameter for this endpoint.

cursor

cursor parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/user/tweets
curl -X GET 'https://socialquery.dev/v1/twitter/user/tweets?handle=elonmusk' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/user/tweets",
  "data": {
    "id": "string",
    "query": "elonmusk",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Tweet

Twitter tweet. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

trim

trim parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/tweet
curl -X GET 'https://socialquery.dev/v1/twitter/tweet?url=https%3A%2F%2Fx.com%2FNASA%2Fstatus%2F2073078061499617543' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/tweet",
  "data": {
    "id": "string",
    "query": "https://x.com/NASA/status/2073078061499617543",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Community

Twitter community. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/community
curl -X GET 'https://socialquery.dev/v1/twitter/community?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F1926186499399139650' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/community",
  "data": {
    "id": "string",
    "query": "https://x.com/i/communities/1926186499399139650",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Community Tweets

Twitter community tweets. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/community/tweets
curl -X GET 'https://socialquery.dev/v1/twitter/community/tweets?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F1926186499399139650' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/community/tweets",
  "data": {
    "id": "string",
    "query": "https://x.com/i/communities/1926186499399139650",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Tweet Transcript

Twitter tweet transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/tweet/transcript
curl -X GET 'https://socialquery.dev/v1/twitter/tweet/transcript?url=https%3A%2F%2Fx.com%2FTheoVon%2Fstatus%2F1916982720317821050' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/tweet/transcript",
  "data": {
    "id": "string",
    "query": "https://x.com/TheoVon/status/1916982720317821050",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Twitter ai search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

from_handles

from_handles parameter for this endpoint.

exclude_handles

exclude_handles parameter for this endpoint.

from_date

from_date parameter for this endpoint.

to_date

to_date parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/ai-search
curl -X GET 'https://socialquery.dev/v1/twitter/ai-search?query=What+is+%40elonmusk+saying+about+xAI+this+week%3F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/ai-search",
  "data": {
    "id": "string",
    "query": "What is @elonmusk saying about xAI this week?",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Search Tweets

Twitter search tweets. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort

sort parameter for this endpoint.

cursor

cursor parameter for this endpoint.

switch_from

switch_from parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

min_views

min_views parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

sort_rows

sort_rows parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/search/tweets
curl -X GET 'https://socialquery.dev/v1/twitter/search/tweets?query=nike+running+shoes' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/search/tweets",
  "data": {
    "id": "string",
    "query": "nike running shoes",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Tweet Replies

Twitter tweet replies. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/tweet/replies
curl -X GET 'https://socialquery.dev/v1/twitter/tweet/replies?url=https%3A%2F%2Fx.com%2FNews24%2Fstatus%2F2093257170653483101' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/tweet/replies",
  "data": {
    "id": "string",
    "query": "https://x.com/News24/status/2093257170653483101",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) User Media

Twitter user media. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/user/media
curl -X GET 'https://socialquery.dev/v1/twitter/user/media?handle=News24' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/user/media",
  "data": {
    "id": "string",
    "query": "News24",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) User Followers

Twitter user followers. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/user/followers
curl -X GET 'https://socialquery.dev/v1/twitter/user/followers?handle=News24' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/user/followers",
  "data": {
    "id": "string",
    "query": "News24",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) User Following

Twitter user following. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/user/following
curl -X GET 'https://socialquery.dev/v1/twitter/user/following?handle=News24' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/user/following",
  "data": {
    "id": "string",
    "query": "News24",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Tweet Retweeters

Twitter tweet retweeters. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/tweet/retweeters
curl -X GET 'https://socialquery.dev/v1/twitter/tweet/retweeters?url=https%3A%2F%2Fx.com%2FNews24%2Fstatus%2F2093257170653483101' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/tweet/retweeters",
  "data": {
    "id": "string",
    "query": "https://x.com/News24/status/2093257170653483101",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Search Users

Twitter search users. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/search/users
curl -X GET 'https://socialquery.dev/v1/twitter/search/users?query=news24' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/search/users",
  "data": {
    "id": "string",
    "query": "news24",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

X (Twitter) Profile Full

Twitter profile full. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

posts

posts parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitter/profile/full
curl -X GET 'https://socialquery.dev/v1/twitter/profile/full?handle=mrbeast' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitter",
  "endpoint": "/v1/twitter/profile/full",
  "data": {
    "id": "string",
    "query": "mrbeast",
    "status": "ok",
    "source": "twitter"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Subreddit

Reddit subreddit. Availability depends on the configured provider route.

Parameters

subredditrequired

subreddit parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

sort

sort parameter for this endpoint.

after

after parameter for this endpoint.

trim

trim parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/subreddit
curl -X GET 'https://socialquery.dev/v1/reddit/subreddit?subreddit=technology' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/subreddit",
  "data": {
    "id": "string",
    "query": "technology",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Subreddit Details

Reddit subreddit details. Availability depends on the configured provider route.

Parameters

subreddit

subreddit parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/subreddit/details
curl -X GET 'https://socialquery.dev/v1/reddit/subreddit/details?subreddit=AskReddit' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/subreddit/details",
  "data": {
    "id": "string",
    "query": "AskReddit",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort

sort parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

after

after parameter for this endpoint.

trim

trim parameter for this endpoint.

include_body

include_body parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

max_age_days

max_age_days parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/search
curl -X GET 'https://socialquery.dev/v1/reddit/search?query=%22claude+code%22' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/search",
  "data": {
    "id": "string",
    "query": "\"claude code\"",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Post

Reddit post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/post
curl -X GET 'https://socialquery.dev/v1/reddit/post?url=https%3A%2F%2Fwww.reddit.com%2Fr%2FNoteTaking%2Fcomments%2F1o9s55r%2Fi_tried_all_popular_ai_notetaking_apps_so_you%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/post",
  "data": {
    "id": "string",
    "query": "https://www.reddit.com/r/NoteTaking/comments/1o9s55r/i_tried_all_popular_ai_notetaking_apps_so_you/",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Post Comments

Reddit post comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/post/comments
curl -X GET 'https://socialquery.dev/v1/reddit/post/comments?url=https%3A%2F%2Fwww.reddit.com%2Fr%2FNoteTaking%2Fcomments%2F1o9s55r%2Fi_tried_all_popular_ai_notetaking_apps_so_you%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.reddit.com/r/NoteTaking/comments/1o9s55r/i_tried_all_popular_ai_notetaking_apps_so_you/",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit subreddit search. Availability depends on the configured provider route.

Parameters

subredditrequired

subreddit parameter for this endpoint.

query

query parameter for this endpoint.

sort

sort parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include_body

include_body parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/subreddit/search
curl -X GET 'https://socialquery.dev/v1/reddit/subreddit/search?subreddit=technology' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/subreddit/search",
  "data": {
    "id": "string",
    "query": "technology",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Profile

Reddit profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/profile
curl -X GET 'https://socialquery.dev/v1/reddit/profile?handle=spez' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/profile",
  "data": {
    "id": "string",
    "query": "spez",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Profile Posts

Reddit profile posts. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

sort

sort parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/profile/posts
curl -X GET 'https://socialquery.dev/v1/reddit/profile/posts?handle=spez' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/profile/posts",
  "data": {
    "id": "string",
    "query": "spez",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Profile Comments

Reddit profile comments. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

limit

limit parameter for this endpoint.

before

before parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/profile/comments
curl -X GET 'https://socialquery.dev/v1/reddit/profile/comments?handle=spez' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/profile/comments",
  "data": {
    "id": "string",
    "query": "spez",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Search Comments

Reddit search comments. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort

sort parameter for this endpoint.

cursor

cursor parameter for this endpoint.

switch_from

switch_from parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/search/comments
curl -X GET 'https://socialquery.dev/v1/reddit/search/comments?query=best+project+management+software' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/search/comments",
  "data": {
    "id": "string",
    "query": "best project management software",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit subreddits search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/subreddits/search
curl -X GET 'https://socialquery.dev/v1/reddit/subreddits/search?query=machine+learning' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/subreddits/search",
  "data": {
    "id": "string",
    "query": "machine learning",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Search Media

Reddit search media. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort

sort parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/search/media
curl -X GET 'https://socialquery.dev/v1/reddit/search/media?query=mechanical+keyboard+build' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/search/media",
  "data": {
    "id": "string",
    "query": "mechanical keyboard build",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit Post Transcript

Reddit post transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/post/transcript
curl -X GET 'https://socialquery.dev/v1/reddit/post/transcript?url=https%3A%2F%2Fwww.reddit.com%2Fr%2Fyouseeingthisshit%2Fcomments%2F1oiu9xm%2Ffootball_nostalgiasaints_punter_head_coach_cant%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/post/transcript",
  "data": {
    "id": "string",
    "query": "https://www.reddit.com/r/youseeingthisshit/comments/1oiu9xm/football_nostalgiasaints_punter_head_coach_cant/",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Reddit omni search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

threads

threads parameter for this endpoint.

sort

sort parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

subreddit

subreddit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/reddit/omni-search
curl -X GET 'https://socialquery.dev/v1/reddit/omni-search?query=best+mechanical+keyboard' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/omni-search",
  "data": {
    "id": "string",
    "query": "best mechanical keyboard",
    "status": "ok",
    "source": "reddit"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver blog search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/blog/search
curl -X GET 'https://socialquery.dev/v1/naver/blog/search?query=%EC%86%8C%EC%85%9C%ED%81%AC%EB%A1%A4' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/blog/search",
  "data": {
    "id": "string",
    "query": "소셜크롤",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver news search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/news/search
curl -X GET 'https://socialquery.dev/v1/naver/news/search?query=%EC%82%BC%EC%84%B1%EC%A0%84%EC%9E%90' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/news/search",
  "data": {
    "id": "string",
    "query": "삼성전자",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver encyc search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/encyc/search
curl -X GET 'https://socialquery.dev/v1/naver/encyc/search?query=%EC%96%91%EC%9E%90%EC%97%AD%ED%95%99' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/encyc/search",
  "data": {
    "id": "string",
    "query": "양자역학",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver cafearticle search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/cafearticle/search
curl -X GET 'https://socialquery.dev/v1/naver/cafearticle/search?query=%EC%A3%BC%EC%8B%9D' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/cafearticle/search",
  "data": {
    "id": "string",
    "query": "주식",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver kin search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

group

group parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/kin/search
curl -X GET 'https://socialquery.dev/v1/naver/kin/search?query=%EC%BD%94%EB%A1%9C%EB%82%98+%EC%A6%9D%EC%83%81' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/kin/search",
  "data": {
    "id": "string",
    "query": "코로나 증상",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver local search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

sort

sort parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/local/search
curl -X GET 'https://socialquery.dev/v1/naver/local/search?query=%EA%B0%95%EB%82%A8%EC%97%AD+%EC%B9%B4%ED%8E%98' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/local/search",
  "data": {
    "id": "string",
    "query": "강남역 카페",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver image search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

filter

filter parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/image/search
curl -X GET 'https://socialquery.dev/v1/naver/image/search?query=%ED%95%9C%EB%9D%BC%EC%82%B0' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/image/search",
  "data": {
    "id": "string",
    "query": "한라산",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver webkr search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/webkr/search
curl -X GET 'https://socialquery.dev/v1/naver/webkr/search?query=%EA%B8%B0%ED%9B%84%EB%B3%80%ED%99%94' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/webkr/search",
  "data": {
    "id": "string",
    "query": "기후변화",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver Errata

Naver errata. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/errata
curl -X GET 'https://socialquery.dev/v1/naver/errata?query=%EB%84%A4%EC%9D%B4%EB%B3%98' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/errata",
  "data": {
    "id": "string",
    "query": "네이볘",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver Adult

Naver adult. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/adult
curl -X GET 'https://socialquery.dev/v1/naver/adult?query=%EC%84%B1%EC%9D%B8%EC%98%81%ED%99%94' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/adult",
  "data": {
    "id": "string",
    "query": "성인영화",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver Search Trend

Naver search trend. Availability depends on the configured provider route.

Parameters

keywords

keywords parameter for this endpoint.

groups

groups parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

time_unit

time_unit parameter for this endpoint.

group_name

group_name parameter for this endpoint.

device

device parameter for this endpoint.

gender

gender parameter for this endpoint.

ages

ages parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/search-trend
curl -X GET 'https://socialquery.dev/v1/naver/search-trend?keywords=%EC%82%BC%EC%84%B1%EC%A0%84%EC%9E%90%2C%EA%B0%A4%EB%9F%AD%EC%8B%9C' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/search-trend",
  "data": {
    "id": "string",
    "query": "삼성전자,갤럭시",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver Shopping Insight Category

Naver shopping insight category. Availability depends on the configured provider route.

Parameters

category_coderequired

category_code parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

time_unit

time_unit parameter for this endpoint.

device

device parameter for this endpoint.

gender

gender parameter for this endpoint.

ages

ages parameter for this endpoint.

breakdown

breakdown parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/shopping-insight/category
curl -X GET 'https://socialquery.dev/v1/naver/shopping-insight/category?category_code=50000000' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/shopping-insight/category",
  "data": {
    "id": "string",
    "query": "50000000",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver Shopping Insight Keyword

Naver shopping insight keyword. Availability depends on the configured provider route.

Parameters

category_coderequired

category_code parameter for this endpoint.

keywordrequired

keyword parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

time_unit

time_unit parameter for this endpoint.

device

device parameter for this endpoint.

gender

gender parameter for this endpoint.

ages

ages parameter for this endpoint.

breakdown

breakdown parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/shopping-insight/keyword
curl -X GET 'https://socialquery.dev/v1/naver/shopping-insight/keyword?category_code=50000000&keyword=%EC%BD%94%ED%8A%B8' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/shopping-insight/keyword",
  "data": {
    "id": "string",
    "query": "50000000",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Naver Brief

Naver brief. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

corpora

corpora parameter for this endpoint.

display

display parameter for this endpoint.

start

start parameter for this endpoint.

sort

sort parameter for this endpoint.

include

include parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/naver/brief
curl -X GET 'https://socialquery.dev/v1/naver/brief?query=%EC%82%BC%EC%84%B1%EC%A0%84%EC%9E%90' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/brief",
  "data": {
    "id": "string",
    "query": "삼성전자",
    "status": "ok",
    "source": "naver"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Endpoints

Utility endpoints. Availability depends on the configured provider route.

Parameters

platform

platform parameter for this endpoint.

search

search parameter for this endpoint.

method

method parameter for this endpoint.

fingerprint

fingerprint parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/endpoints
curl -X GET 'https://socialquery.dev/v1/utility/endpoints' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/endpoints",
  "data": {
    "id": "string",
    "query": "tiktok",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Endpoint

Utility endpoint. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

method

method parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/endpoint
curl -X GET 'https://socialquery.dev/v1/utility/endpoint?id=tiktok%2Fprofile' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/endpoint",
  "data": {
    "id": "string",
    "query": "tiktok/profile",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Capabilities

Utility capabilities. Availability depends on the configured provider route.

Parameters

param

param parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/capabilities
curl -X GET 'https://socialquery.dev/v1/utility/capabilities' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/capabilities",
  "data": {
    "id": "string",
    "query": "relevance",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Plan

Utility plan. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

task

task parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/plan
curl -X GET 'https://socialquery.dev/v1/utility/plan?query=Combine+%40acme%27s+TikTok+profile+with+their+recent+videos+and+the+comments+on+them' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/plan",
  "data": {
    "id": "string",
    "query": "Combine @acme's TikTok profile with their recent videos and the comments on them",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Resolve

Utility resolve. Availability depends on the configured provider route.

Parameters

input

input parameter for this endpoint.

inputs

inputs parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/resolve
curl -X GET 'https://socialquery.dev/v1/utility/resolve?input=https%3A%2F%2Fwww.tiktok.com%2F%40charlidamelio%2Fvideo%2F7234567890123456789' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/resolve",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/@charlidamelio/video/7234567890123456789",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Estimate

Utility estimate. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

method

method parameter for this endpoint.

params

params parameter for this endpoint.

body

body parameter for this endpoint.

items

items parameter for this endpoint.

plan

plan parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/estimate
curl -X GET 'https://socialquery.dev/v1/utility/estimate?id=tiktok%2Fpost%2Fcomments' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/estimate",
  "data": {
    "id": "string",
    "query": "tiktok/post/comments",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Explain Error

Utility explain error. Availability depends on the configured provider route.

Parameters

status

status parameter for this endpoint.

body

body parameter for this endpoint.

request

request parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/explain-error
curl -X GET 'https://socialquery.dev/v1/utility/explain-error?body=%7B%22success%22%3Afalse%2C%22error%22%3A%7B%22type%22%3A%22INVALID_REQUEST%22%2C%22message%22%3A%22Unknown+query+parameter+%27handel%27.+Did+you+mean+%27handle%27%3F%22%2C%22status%22%3A400%2C%22details%22%3A%7B%22unknown_parameters%22%3A%5B%22handel%22%5D%2C%22suggestions%22%3A%7B%22handel%22%3A%22handle%22%7D%7D%7D%7D' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/explain-error",
  "data": {
    "id": "string",
    "query": "400",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility docs search. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

q

q parameter for this endpoint.

platform

platform parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/docs-search
curl -X GET 'https://socialquery.dev/v1/utility/docs-search?query=how+does+cursor+pagination+work' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/docs-search",
  "data": {
    "id": "string",
    "query": "how does cursor pagination work",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Find

Utility find. Availability depends on the configured provider route.

Parameters

task

task parameter for this endpoint.

query

query parameter for this endpoint.

platform

platform parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/find
curl -X GET 'https://socialquery.dev/v1/utility/find?task=last+200+comments+on+https%3A%2F%2Fwww.tiktok.com%2F%40stoolpresidente%2Fvideo%2F7623818255903329566' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/find",
  "data": {
    "id": "string",
    "query": "last 200 comments on https://www.tiktok.com/@stoolpresidente/video/7623818255903329566",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Recipes

Utility recipes. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/recipes
curl -X GET 'https://socialquery.dev/v1/utility/recipes' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/recipes",
  "data": {
    "id": "string",
    "query": "export-tiktok-comments",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Quickstart

Utility quickstart. Availability depends on the configured provider route.

Parameters

platform

platform parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/quickstart
curl -X GET 'https://socialquery.dev/v1/utility/quickstart' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/quickstart",
  "data": {
    "id": "string",
    "query": "tiktok",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Utility Llms

Utility llms. Availability depends on the configured provider route.

Parameters

platform

platform parameter for this endpoint.

format

format parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/utility/llms
curl -X GET 'https://socialquery.dev/v1/utility/llms' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/llms",
  "data": {
    "id": "string",
    "query": "tiktok",
    "status": "ok",
    "source": "utility"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Profile

Github profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/profile
curl -X GET 'https://socialquery.dev/v1/github/profile?handle=octocat' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/profile",
  "data": {
    "id": "string",
    "query": "octocat",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Repo

Github repo. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/repo
curl -X GET 'https://socialquery.dev/v1/github/repo?url=https%3A%2F%2Fgithub.com%2Foctocat%2FHello-World' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo",
  "data": {
    "id": "string",
    "query": "https://github.com/octocat/Hello-World",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Profile Repos

Github profile repos. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

type

type parameter for this endpoint.

sort

sort parameter for this endpoint.

direction

direction parameter for this endpoint.

per_page

per_page parameter for this endpoint.

page

page parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/profile/repos
curl -X GET 'https://socialquery.dev/v1/github/profile/repos?handle=octocat' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/profile/repos",
  "data": {
    "id": "string",
    "query": "octocat",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Repo Readme

Github repo readme. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/repo/readme
curl -X GET 'https://socialquery.dev/v1/github/repo/readme?url=https%3A%2F%2Fgithub.com%2Foctocat%2FHello-World' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo/readme",
  "data": {
    "id": "string",
    "query": "https://github.com/octocat/Hello-World",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Repo Releases

Github repo releases. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

per_page

per_page parameter for this endpoint.

page

page parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/repo/releases
curl -X GET 'https://socialquery.dev/v1/github/repo/releases?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo/releases",
  "data": {
    "id": "string",
    "query": "https://github.com/facebook/react",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Repo Issues

Github repo issues. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

type

type parameter for this endpoint.

state

state parameter for this endpoint.

labels

labels parameter for this endpoint.

sort

sort parameter for this endpoint.

direction

direction parameter for this endpoint.

since

since parameter for this endpoint.

per_page

per_page parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/repo/issues
curl -X GET 'https://socialquery.dev/v1/github/repo/issues?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo/issues",
  "data": {
    "id": "string",
    "query": "https://github.com/facebook/react",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Issue

Github issue. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/issue
curl -X GET 'https://socialquery.dev/v1/github/issue?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact%2Fissues%2F27522' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/issue",
  "data": {
    "id": "string",
    "query": "https://github.com/facebook/react/issues/27522",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Issue Comments

Github issue comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

since

since parameter for this endpoint.

per_page

per_page parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/issue/comments
curl -X GET 'https://socialquery.dev/v1/github/issue/comments?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact%2Fissues%2F27522' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/issue/comments",
  "data": {
    "id": "string",
    "query": "https://github.com/facebook/react/issues/27522",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Github search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort

sort parameter for this endpoint.

order

order parameter for this endpoint.

per_page

per_page parameter for this endpoint.

page

page parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/search
curl -X GET 'https://socialquery.dev/v1/github/search?query=repo%3Avercel%2Fnext.js+is%3Aissue+is%3Aopen' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/search",
  "data": {
    "id": "string",
    "query": "repo:vercel/next.js is:issue is:open",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Repo Top Issues

Github repo top issues. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/repo/top-issues
curl -X GET 'https://socialquery.dev/v1/github/repo/top-issues?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo/top-issues",
  "data": {
    "id": "string",
    "query": "https://github.com/facebook/react",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub Repo Dossier

Github repo dossier. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/repo/dossier
curl -X GET 'https://socialquery.dev/v1/github/repo/dossier?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo/dossier",
  "data": {
    "id": "string",
    "query": "https://github.com/facebook/react",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

GitHub User Profile Velocity

Github user profile velocity. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/github/user/profile-velocity
curl -X GET 'https://socialquery.dev/v1/github/user/profile-velocity?handle=octocat' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/user/profile-velocity",
  "data": {
    "id": "string",
    "query": "octocat",
    "status": "ok",
    "source": "github"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

region

region parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/search
curl -X GET 'https://socialquery.dev/v1/google/search?query=best+restaurants+in+London' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/search",
  "data": {
    "id": "string",
    "query": "best restaurants in London",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Ad

Google ad. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/ad
curl -X GET 'https://socialquery.dev/v1/google/ad?url=https%3A%2F%2Fadstransparency.google.com%2Fadvertiser%2FAR01614014350098432001%2Fcreative%2FCR10449491775734153217' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/ad",
  "data": {
    "id": "string",
    "query": "https://adstransparency.google.com/advertiser/AR01614014350098432001/creative/CR10449491775734153217",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google adlibrary advertisers search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/adlibrary/advertisers/search
curl -X GET 'https://socialquery.dev/v1/google/adlibrary/advertisers/search?query=lululemon' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/adlibrary/advertisers/search",
  "data": {
    "id": "string",
    "query": "lululemon",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Company Ads

Google company ads. Availability depends on the configured provider route.

Parameters

domain

domain parameter for this endpoint.

advertiser_id

advertiser_id parameter for this endpoint.

topic

topic parameter for this endpoint.

region

region parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

platform

platform parameter for this endpoint.

format

format parameter for this endpoint.

get_ad_details

get_ad_details parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/company/ads
curl -X GET 'https://socialquery.dev/v1/google/company/ads?domain=lululemon.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/company/ads",
  "data": {
    "id": "string",
    "query": "lululemon.com",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Business Info

Google business info. Availability depends on the configured provider route.

Parameters

keyword

keyword parameter for this endpoint.

cid

cid parameter for this endpoint.

place_id

place_id parameter for this endpoint.

location_name

location_name parameter for this endpoint.

language_name

language_name parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/business/info
curl -X GET 'https://socialquery.dev/v1/google/business/info?keyword=Irving+Farm+New+York+645+5th+Ave' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/business/info",
  "data": {
    "id": "string",
    "query": "Irving Farm New York 645 5th Ave",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Business Extended Reviews

Google business extended reviews. Availability depends on the configured provider route.

Parameters

keyword

keyword parameter for this endpoint.

cid

cid parameter for this endpoint.

place_id

place_id parameter for this endpoint.

location_name

location_name parameter for this endpoint.

language_name

language_name parameter for this endpoint.

depth

depth parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/business/extended-reviews
curl -X GET 'https://socialquery.dev/v1/google/business/extended-reviews?keyword=Irving+Farm+New+York+645+5th+Ave' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/business/extended-reviews",
  "data": {
    "id": "string",
    "query": "Irving Farm New York 645 5th Ave",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Business Updates

Google business updates. Availability depends on the configured provider route.

Parameters

keyword

keyword parameter for this endpoint.

cid

cid parameter for this endpoint.

location_name

location_name parameter for this endpoint.

language_name

language_name parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/business/updates
curl -X GET 'https://socialquery.dev/v1/google/business/updates?keyword=Toyota+of+Manhattan+New+York' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/business/updates",
  "data": {
    "id": "string",
    "query": "Toyota of Manhattan New York",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Business Questions

Google business questions. Availability depends on the configured provider route.

Parameters

keyword

keyword parameter for this endpoint.

cid

cid parameter for this endpoint.

place_id

place_id parameter for this endpoint.

location_name

location_name parameter for this endpoint.

language_name

language_name parameter for this endpoint.

depth

depth parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/business/questions
curl -X GET 'https://socialquery.dev/v1/google/business/questions?keyword=Starbucks+Reserve+Roastery+New+York' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/business/questions",
  "data": {
    "id": "string",
    "query": "Starbucks Reserve Roastery New York",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google hotels search. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

location_name

location_name parameter for this endpoint.

language_name

language_name parameter for this endpoint.

check_in

check_in parameter for this endpoint.

check_out

check_out parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/hotels/search
curl -X GET 'https://socialquery.dev/v1/google/hotels/search?keyword=hotels+in+New+York' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/hotels/search",
  "data": {
    "id": "string",
    "query": "hotels in New York",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Hotels Info

Google hotels info. Availability depends on the configured provider route.

Parameters

hotel_identifierrequired

hotel_identifier parameter for this endpoint.

location_name

location_name parameter for this endpoint.

language_name

language_name parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/hotels/info
curl -X GET 'https://socialquery.dev/v1/google/hotels/info?hotel_identifier=ChkIoYjXwK-S_okHGg0vZy8xMW1fd3MzY243EAE' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/hotels/info",
  "data": {
    "id": "string",
    "query": "ChkIoYjXwK-S_okHGg0vZy8xMW1fd3MzY243EAE",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Keyword Volume

Google keyword volume. Availability depends on the configured provider route.

Parameters

keywordsrequired

keywords parameter for this endpoint.

location

location parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google/keyword-volume
curl -X GET 'https://socialquery.dev/v1/google/keyword-volume?keywords=lip+gloss%2Clip+oil' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google",
  "endpoint": "/v1/google/keyword-volume",
  "data": {
    "id": "string",
    "query": "lip gloss,lip oil",
    "status": "ok",
    "source": "google"
  },
  "credits_used": 16,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Product

Sephora product. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

sku

sku parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/product
curl -X GET 'https://socialquery.dev/v1/sephora/product?product_id=P427414' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/product",
  "data": {
    "id": "string",
    "query": "P427414",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Reviews

Sephora reviews. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

limit

limit parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

rating

rating parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/reviews
curl -X GET 'https://socialquery.dev/v1/sephora/reviews?product_id=P427414' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/reviews",
  "data": {
    "id": "string",
    "query": "P427414",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

page_size

page_size parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_rating

min_rating parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

is_new

is_new parameter for this endpoint.

category_id

category_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/search
curl -X GET 'https://socialquery.dev/v1/sephora/search?query=moisturizer' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/search",
  "data": {
    "id": "string",
    "query": "moisturizer",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Search Suggestions

Sephora search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/search/suggestions
curl -X GET 'https://socialquery.dev/v1/sephora/search/suggestions?query=moistur' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/search/suggestions",
  "data": {
    "id": "string",
    "query": "moistur",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Category

Sephora category. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

page

page parameter for this endpoint.

page_size

page_size parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/category
curl -X GET 'https://socialquery.dev/v1/sephora/category?category_id=cat1100057' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/category",
  "data": {
    "id": "string",
    "query": "cat1100057",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Categories

Sephora categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/categories
curl -X GET 'https://socialquery.dev/v1/sephora/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/categories",
  "data": {
    "id": "string",
    "query": "/v1/sephora/categories",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Category Data

Sephora category data. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/category/data
curl -X GET 'https://socialquery.dev/v1/sephora/category/data?id=cat1100057' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/category/data",
  "data": {
    "id": "string",
    "query": "cat1100057",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Brands

Sephora brands. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/brands
curl -X GET 'https://socialquery.dev/v1/sephora/brands' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/brands",
  "data": {
    "id": "string",
    "query": "/v1/sephora/brands",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Brand Products

Sephora brand products. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

page

page parameter for this endpoint.

page_size

page_size parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

min_rating

min_rating parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/brand/products
curl -X GET 'https://socialquery.dev/v1/sephora/brand/products?id=gucci' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/brand/products",
  "data": {
    "id": "string",
    "query": "gucci",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Stores

Sephora stores. Availability depends on the configured provider route.

Parameters

location_coordinaterequired

location_coordinate parameter for this endpoint.

radius

radius parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/stores
curl -X GET 'https://socialquery.dev/v1/sephora/stores?location_coordinate=37.4418834%2C-122.1430195' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/stores",
  "data": {
    "id": "string",
    "query": "37.4418834,-122.1430195",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Sephora Availability

Sephora availability. Availability depends on the configured provider route.

Parameters

skurequired

sku parameter for this endpoint.

latitude

latitude parameter for this endpoint.

longitude

longitude parameter for this endpoint.

location_coordinate

location_coordinate parameter for this endpoint.

radius

radius parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/sephora/availability
curl -X GET 'https://socialquery.dev/v1/sephora/availability?sku=2210581&location_coordinate=37.4418834%2C-122.1430195' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "sephora",
  "endpoint": "/v1/sephora/availability",
  "data": {
    "id": "string",
    "query": "2210581",
    "status": "ok",
    "source": "sephora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree search. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

category_id

category_id parameter for this endpoint.

location_id

location_id parameter for this endpoint.

distance

distance parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

seller_type

seller_type parameter for this endpoint.

attributes

attributes parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/search
curl -X GET 'https://socialquery.dev/v1/gumtree/search?query=iphone' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/search",
  "data": {
    "id": "string",
    "query": "iphone",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Product

Gumtree product. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/product
curl -X GET 'https://socialquery.dev/v1/gumtree/product?product_id=1515115590' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/product",
  "data": {
    "id": "string",
    "query": "1515115590",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Product Similar

Gumtree product similar. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/product/similar
curl -X GET 'https://socialquery.dev/v1/gumtree/product/similar?product_id=1515115590' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/product/similar",
  "data": {
    "id": "string",
    "query": "1515115590",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Seller

Gumtree seller. Availability depends on the configured provider route.

Parameters

seller_id

seller_id parameter for this endpoint.

public_id

public_id parameter for this endpoint.

account_id

account_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/seller
curl -X GET 'https://socialquery.dev/v1/gumtree/seller?seller_id=17804454' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/seller",
  "data": {
    "id": "string",
    "query": "17804454",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Seller Listings

Gumtree seller listings. Availability depends on the configured provider route.

Parameters

seller_id

seller_id parameter for this endpoint.

public_id

public_id parameter for this endpoint.

account_id

account_id parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/seller/listings
curl -X GET 'https://socialquery.dev/v1/gumtree/seller/listings?seller_id=17804454' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/seller/listings",
  "data": {
    "id": "string",
    "query": "17804454",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Search Suggestions

Gumtree search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

category_id

category_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/search/suggestions
curl -X GET 'https://socialquery.dev/v1/gumtree/search/suggestions?query=iphone' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/search/suggestions",
  "data": {
    "id": "string",
    "query": "iphone",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree trending. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/trending
curl -X GET 'https://socialquery.dev/v1/gumtree/trending' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/trending",
  "data": {
    "id": "string",
    "query": "/v1/gumtree/trending",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Categories

Gumtree categories. Availability depends on the configured provider route.

Parameters

category_id

category_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/categories
curl -X GET 'https://socialquery.dev/v1/gumtree/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/categories",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Filters

Gumtree filters. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/filters
curl -X GET 'https://socialquery.dev/v1/gumtree/filters?category_id=10205' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/filters",
  "data": {
    "id": "string",
    "query": "10205",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Locations

Gumtree locations. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

location_type

location_type parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/locations
curl -X GET 'https://socialquery.dev/v1/gumtree/locations?query=london' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/locations",
  "data": {
    "id": "string",
    "query": "london",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Gumtree Locations Nearest

Gumtree locations nearest. Availability depends on the configured provider route.

Parameters

latitude

latitude parameter for this endpoint.

longitude

longitude parameter for this endpoint.

location_coordinate

location_coordinate parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/gumtree/locations/nearest
curl -X GET 'https://socialquery.dev/v1/gumtree/locations/nearest?location_coordinate=51.5074%2C-0.1278' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "gumtree",
  "endpoint": "/v1/gumtree/locations/nearest",
  "data": {
    "id": "string",
    "query": "",
    "status": "ok",
    "source": "gumtree"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs linkedin search. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

location

location parameter for this endpoint.

organization_ids

organization_ids parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

employment_types

employment_types parameter for this endpoint.

experience_levels

experience_levels parameter for this endpoint.

workplace_types

workplace_types parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/linkedin/search
curl -X GET 'https://socialquery.dev/v1/jobs/linkedin/search?query=software+engineer' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/linkedin/search",
  "data": {
    "id": "string",
    "query": "software engineer",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs Linkedin

Jobs linkedin. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/linkedin
curl -X GET 'https://socialquery.dev/v1/jobs/linkedin?id=4460359588' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/linkedin",
  "data": {
    "id": "string",
    "query": "4460359588",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs Linkedin Organizations

Jobs linkedin organizations. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/linkedin/organizations
curl -X GET 'https://socialquery.dev/v1/jobs/linkedin/organizations?query=google' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/linkedin/organizations",
  "data": {
    "id": "string",
    "query": "google",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs indeed search. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

location

location parameter for this endpoint.

country_code

country_code parameter for this endpoint.

sort_type

sort_type parameter for this endpoint.

radius

radius parameter for this endpoint.

radius_type

radius_type parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/indeed/search
curl -X GET 'https://socialquery.dev/v1/jobs/indeed/search?query=software+engineer&country_code=us' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/indeed/search",
  "data": {
    "id": "string",
    "query": "software engineer",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs Indeed

Jobs indeed. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/indeed
curl -X GET 'https://socialquery.dev/v1/jobs/indeed?id=aWQ9NWExYzEwM2YzOTEzODljNDtjYz11cw%3D%3D' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/indeed",
  "data": {
    "id": "string",
    "query": "aWQ9NWExYzEwM2YzOTEzODljNDtjYz11cw==",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs bing search. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

location

location parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

employment_types

employment_types parameter for this endpoint.

remote_only

remote_only parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/bing/search
curl -X GET 'https://socialquery.dev/v1/jobs/bing/search?query=software+engineer&location=United+States' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/bing/search",
  "data": {
    "id": "string",
    "query": "software engineer",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs Bing

Jobs bing. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/bing
curl -X GET 'https://socialquery.dev/v1/jobs/bing?id=MTE5OTc2NjYxOS5SZXRybw%3D%3D' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/bing",
  "data": {
    "id": "string",
    "query": "MTE5OTc2NjYxOS5SZXRybw==",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs xing search. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

location

location parameter for this endpoint.

date_posted

date_posted parameter for this endpoint.

employment_types

employment_types parameter for this endpoint.

career_levels

career_levels parameter for this endpoint.

remote_options

remote_options parameter for this endpoint.

minimum_salary

minimum_salary parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/xing/search
curl -X GET 'https://socialquery.dev/v1/jobs/xing/search?query=software+engineer' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/xing/search",
  "data": {
    "id": "string",
    "query": "software engineer",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs Xing

Jobs xing. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/xing
curl -X GET 'https://socialquery.dev/v1/jobs/xing?id=YmVybGluLXNlbmlvci1zb2x1dGlvbi1lbmdpbmVlci0xNTY3NTI5MTA%3D' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/xing",
  "data": {
    "id": "string",
    "query": "YmVybGluLXNlbmlvci1zb2x1dGlvbi1lbmdpbmVlci0xNTY3NTI5MTA=",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs Salary Titles

Jobs salary titles. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country_coderequired

country_code parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/salary/titles
curl -X GET 'https://socialquery.dev/v1/jobs/salary/titles?query=software&country_code=us' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/salary/titles",
  "data": {
    "id": "string",
    "query": "software",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Jobs Salary

Jobs salary. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country_coderequired

country_code parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/jobs/salary
curl -X GET 'https://socialquery.dev/v1/jobs/salary?query=software+engineer&country_code=us' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "jobs",
  "endpoint": "/v1/jobs/salary",
  "data": {
    "id": "string",
    "query": "software engineer",
    "status": "ok",
    "source": "jobs"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play app search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/app-search
curl -X GET 'https://socialquery.dev/v1/google_play/app-search?query=photo+editor' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/app-search",
  "data": {
    "id": "string",
    "query": "photo editor",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play Search Suggestions

Google Play search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/search-suggestions
curl -X GET 'https://socialquery.dev/v1/google_play/search-suggestions?query=reverse' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/search-suggestions",
  "data": {
    "id": "string",
    "query": "reverse",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play App Info

Google Play app info. Availability depends on the configured provider route.

Parameters

app_idrequired

app_id parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/app-info
curl -X GET 'https://socialquery.dev/v1/google_play/app-info?app_id=com.spotify.music' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/app-info",
  "data": {
    "id": "string",
    "query": "com.spotify.music",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play App Reviews

Google Play app reviews. Availability depends on the configured provider route.

Parameters

app_idrequired

app_id parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

rating

rating parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/app-reviews
curl -X GET 'https://socialquery.dev/v1/google_play/app-reviews?app_id=com.spotify.music' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/app-reviews",
  "data": {
    "id": "string",
    "query": "com.spotify.music",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play App List

Google Play app list. Availability depends on the configured provider route.

Parameters

app_collectionrequired

app_collection parameter for this endpoint.

app_category

app_category parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/app-list
curl -X GET 'https://socialquery.dev/v1/google_play/app-list?app_collection=topselling_free' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/app-list",
  "data": {
    "id": "string",
    "query": "topselling_free",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play app listings search. Availability depends on the configured provider route.

Parameters

titlerequired

title parameter for this endpoint.

description

description parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

offset_token

offset_token parameter for this endpoint.

filters

filters parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/app-listings-search
curl -X GET 'https://socialquery.dev/v1/google_play/app-listings-search?title=photo+editor' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/app-listings-search",
  "data": {
    "id": "string",
    "query": "photo editor",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play Categories

Google Play categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/categories
curl -X GET 'https://socialquery.dev/v1/google_play/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/categories",
  "data": {
    "id": "string",
    "query": "/v1/google_play/categories",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play Locations

Google Play locations. Availability depends on the configured provider route.

Parameters

location_type

location_type parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/locations
curl -X GET 'https://socialquery.dev/v1/google_play/locations' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/locations",
  "data": {
    "id": "string",
    "query": "country",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Play Languages

Google Play languages. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_play/languages
curl -X GET 'https://socialquery.dev/v1/google_play/languages' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_play",
  "endpoint": "/v1/google_play/languages",
  "data": {
    "id": "string",
    "query": "/v1/google_play/languages",
    "status": "ok",
    "source": "google_play"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store app search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/app-search
curl -X GET 'https://socialquery.dev/v1/app_store/app-search?query=photo+editor' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/app-search",
  "data": {
    "id": "string",
    "query": "photo editor",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store Search Suggestions

App Store search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/search-suggestions
curl -X GET 'https://socialquery.dev/v1/app_store/search-suggestions?query=reverse' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/search-suggestions",
  "data": {
    "id": "string",
    "query": "reverse",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store App Info

App Store app info. Availability depends on the configured provider route.

Parameters

app_idrequired

app_id parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/app-info
curl -X GET 'https://socialquery.dev/v1/app_store/app-info?app_id=324684580' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/app-info",
  "data": {
    "id": "string",
    "query": "324684580",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store App Reviews

App Store app reviews. Availability depends on the configured provider route.

Parameters

app_idrequired

app_id parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

rating

rating parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/app-reviews
curl -X GET 'https://socialquery.dev/v1/app_store/app-reviews?app_id=324684580' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/app-reviews",
  "data": {
    "id": "string",
    "query": "324684580",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store App List

App Store app list. Availability depends on the configured provider route.

Parameters

app_collectionrequired

app_collection parameter for this endpoint.

app_category

app_category parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/app-list
curl -X GET 'https://socialquery.dev/v1/app_store/app-list?app_collection=top_free_ios' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/app-list",
  "data": {
    "id": "string",
    "query": "top_free_ios",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store app listings search. Availability depends on the configured provider route.

Parameters

titlerequired

title parameter for this endpoint.

description

description parameter for this endpoint.

limit

limit parameter for this endpoint.

offset

offset parameter for this endpoint.

offset_token

offset_token parameter for this endpoint.

filters

filters parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/app-listings-search
curl -X GET 'https://socialquery.dev/v1/app_store/app-listings-search?title=photo+editor' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/app-listings-search",
  "data": {
    "id": "string",
    "query": "photo editor",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store Categories

App Store categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/categories
curl -X GET 'https://socialquery.dev/v1/app_store/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/categories",
  "data": {
    "id": "string",
    "query": "/v1/app_store/categories",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store Locations

App Store locations. Availability depends on the configured provider route.

Parameters

location_type

location_type parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/locations
curl -X GET 'https://socialquery.dev/v1/app_store/locations' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/locations",
  "data": {
    "id": "string",
    "query": "country",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

App Store Languages

App Store languages. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/app_store/languages
curl -X GET 'https://socialquery.dev/v1/app_store/languages' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "app_store",
  "endpoint": "/v1/app_store/languages",
  "data": {
    "id": "string",
    "query": "/v1/app_store/languages",
    "status": "ok",
    "source": "app_store"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Product

Aliexpress product. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/product
curl -X GET 'https://socialquery.dev/v1/aliexpress/product?product_id=3256812847028710' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/product",
  "data": {
    "id": "string",
    "query": "3256812847028710",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

page_size

page_size parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

category_id

category_id parameter for this endpoint.

delivery_days

delivery_days parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/search
curl -X GET 'https://socialquery.dev/v1/aliexpress/search?query=xiaomi' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/search",
  "data": {
    "id": "string",
    "query": "xiaomi",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Product Similar

Aliexpress product similar. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

query

query parameter for this endpoint.

page

page parameter for this endpoint.

page_size

page_size parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/product/similar
curl -X GET 'https://socialquery.dev/v1/aliexpress/product/similar?product_id=3256812847028710' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/product/similar",
  "data": {
    "id": "string",
    "query": "3256812847028710",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Reviews

Aliexpress reviews. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

filter

filter parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/reviews
curl -X GET 'https://socialquery.dev/v1/aliexpress/reviews?product_id=1005006079931969' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/reviews",
  "data": {
    "id": "string",
    "query": "1005006079931969",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Product Shipping

Aliexpress product shipping. Availability depends on the configured provider route.

Parameters

sku_idrequired

sku_id parameter for this endpoint.

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

price

price parameter for this endpoint.

tax_rate

tax_rate parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/product/shipping
curl -X GET 'https://socialquery.dev/v1/aliexpress/product/shipping?sku_id=12000060082591973&product_id=3256812847028710' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/product/shipping",
  "data": {
    "id": "string",
    "query": "12000060082591973",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Search Hot

Aliexpress search hot. Availability depends on the configured provider route.

Parameters

query

query parameter for this endpoint.

page

page parameter for this endpoint.

page_size

page_size parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

category_id

category_id parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/search/hot
curl -X GET 'https://socialquery.dev/v1/aliexpress/search/hot' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/search/hot",
  "data": {
    "id": "string",
    "query": "xiaomi",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Search Promo

Aliexpress search promo. Availability depends on the configured provider route.

Parameters

promotion_namerequired

promotion_name parameter for this endpoint.

page

page parameter for this endpoint.

page_size

page_size parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

category_id

category_id parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/search/promo
curl -X GET 'https://socialquery.dev/v1/aliexpress/search/promo?promotion_name=0203-Knasta-202602-PE' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/search/promo",
  "data": {
    "id": "string",
    "query": "0203-Knasta-202602-PE",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Categories

Aliexpress categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/categories
curl -X GET 'https://socialquery.dev/v1/aliexpress/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/categories",
  "data": {
    "id": "string",
    "query": "/v1/aliexpress/categories",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Aliexpress Promo

Aliexpress promo. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/aliexpress/promo
curl -X GET 'https://socialquery.dev/v1/aliexpress/promo' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/promo",
  "data": {
    "id": "string",
    "query": "/v1/aliexpress/promo",
    "status": "ok",
    "source": "aliexpress"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon Shop

Amazon shop. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/shop
curl -X GET 'https://socialquery.dev/v1/amazon/shop?url=https%3A%2F%2Fwww.amazon.com%2Fshop%2Fsydneydelrey' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/shop",
  "data": {
    "id": "string",
    "query": "https://www.amazon.com/shop/sydneydelrey",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon product search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

depth

depth parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/product-search
curl -X GET 'https://socialquery.dev/v1/amazon/product-search?query=wireless+earbuds' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/product-search",
  "data": {
    "id": "string",
    "query": "wireless earbuds",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon Product

Amazon product. Availability depends on the configured provider route.

Parameters

asinrequired

asin parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/product
curl -X GET 'https://socialquery.dev/v1/amazon/product?asin=B0FQFB8FMG' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/product",
  "data": {
    "id": "string",
    "query": "B0FQFB8FMG",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon Reviews

Amazon reviews. Availability depends on the configured provider route.

Parameters

asinrequired

asin parameter for this endpoint.

country

country parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/reviews
curl -X GET 'https://socialquery.dev/v1/amazon/reviews?asin=B0BTYCRJSS' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/reviews",
  "data": {
    "id": "string",
    "query": "B0BTYCRJSS",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon Sellers

Amazon sellers. Availability depends on the configured provider route.

Parameters

asinrequired

asin parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/sellers
curl -X GET 'https://socialquery.dev/v1/amazon/sellers?asin=B09SM24S8C' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/sellers",
  "data": {
    "id": "string",
    "query": "B09SM24S8C",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon Best Sellers

Amazon best sellers. Availability depends on the configured provider route.

Parameters

categoryrequired

category parameter for this endpoint.

country

country parameter for this endpoint.

type

type parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/best-sellers
curl -X GET 'https://socialquery.dev/v1/amazon/best-sellers?category=software' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/best-sellers",
  "data": {
    "id": "string",
    "query": "software",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon Deals

Amazon deals. Availability depends on the configured provider route.

Parameters

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/deals
curl -X GET 'https://socialquery.dev/v1/amazon/deals' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/deals",
  "data": {
    "id": "string",
    "query": "US",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Amazon Seller

Amazon seller. Availability depends on the configured provider route.

Parameters

seller_idrequired

seller_id parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/amazon/seller
curl -X GET 'https://socialquery.dev/v1/amazon/seller?seller_id=A294P4X9EWVXLJ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "amazon",
  "endpoint": "/v1/amazon/seller",
  "data": {
    "id": "string",
    "query": "A294P4X9EWVXLJ",
    "status": "ok",
    "source": "amazon"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance Quote

Finance quote. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

language

language parameter for this endpoint.

location

location parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/quote
curl -X GET 'https://socialquery.dev/v1/finance/quote?keyword=GOOGL%3ANASDAQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/quote",
  "data": {
    "id": "string",
    "query": "GOOGL:NASDAQ",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance ticker search. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

category

category parameter for this endpoint.

language

language parameter for this endpoint.

location

location parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/ticker-search
curl -X GET 'https://socialquery.dev/v1/finance/ticker-search?keyword=Apple' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/ticker-search",
  "data": {
    "id": "string",
    "query": "Apple",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance Markets

Finance markets. Availability depends on the configured provider route.

Parameters

language

language parameter for this endpoint.

location

location parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/markets
curl -X GET 'https://socialquery.dev/v1/finance/markets' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/markets",
  "data": {
    "id": "string",
    "query": "en",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance News

Finance news. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/news
curl -X GET 'https://socialquery.dev/v1/finance/news?keyword=AAPL' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/news",
  "data": {
    "id": "string",
    "query": "AAPL",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance History

Finance history. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

start_daterequired

start_date parameter for this endpoint.

end_daterequired

end_date parameter for this endpoint.

interval

interval parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/history
curl -X GET 'https://socialquery.dev/v1/finance/history?keyword=AAPL&start_date=2026-06-01&end_date=2026-09-01' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/history",
  "data": {
    "id": "string",
    "query": "AAPL",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance Statements

Finance statements. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

type

type parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/statements
curl -X GET 'https://socialquery.dev/v1/finance/statements?keyword=AAPL' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/statements",
  "data": {
    "id": "string",
    "query": "AAPL",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance Options

Finance options. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

expiry

expiry parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/options
curl -X GET 'https://socialquery.dev/v1/finance/options?keyword=AAPL' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/options",
  "data": {
    "id": "string",
    "query": "AAPL",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Finance Fundamentals

Finance fundamentals. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

period

period parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/finance/fundamentals
curl -X GET 'https://socialquery.dev/v1/finance/fundamentals?keyword=TGT' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/fundamentals",
  "data": {
    "id": "string",
    "query": "TGT",
    "status": "ok",
    "source": "finance"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

limit

limit parameter for this endpoint.

sort

sort parameter for this endpoint.

published

published parameter for this endpoint.

duration

duration parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/search
curl -X GET 'https://socialquery.dev/v1/douyin/search?query=%E7%BE%8E%E9%A3%9F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/search",
  "data": {
    "id": "string",
    "query": "美食",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin Profile

Douyin profile. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

id

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/profile
curl -X GET 'https://socialquery.dev/v1/douyin/profile?handle=instagram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/profile",
  "data": {
    "id": "string",
    "query": "instagram",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 6,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin Profile Posts

Douyin profile posts. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

id

id parameter for this endpoint.

limit

limit parameter for this endpoint.

recent_days

recent_days parameter for this endpoint.

exclude_pinned

exclude_pinned parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/profile/posts
curl -X GET 'https://socialquery.dev/v1/douyin/profile/posts?handle=instagram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/profile/posts",
  "data": {
    "id": "string",
    "query": "instagram",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin Post

Douyin post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/post
curl -X GET 'https://socialquery.dev/v1/douyin/post?url=https%3A%2F%2Fwww.douyin.com%2Fvideo%2F7681266289940544369' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/post",
  "data": {
    "id": "string",
    "query": "https://www.douyin.com/video/7681266289940544369",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin Post Comments

Douyin post comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/post/comments
curl -X GET 'https://socialquery.dev/v1/douyin/post/comments?url=https%3A%2F%2Fwww.douyin.com%2Fvideo%2F7681266289940544369' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.douyin.com/video/7681266289940544369",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 2,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin Comment Replies

Douyin comment replies. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

comment_idrequired

comment_id parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/comment/replies
curl -X GET 'https://socialquery.dev/v1/douyin/comment/replies?url=https%3A%2F%2Fwww.douyin.com%2Fvideo%2F7681266289940544369&comment_id=7682735175344833317' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/comment/replies",
  "data": {
    "id": "string",
    "query": "https://www.douyin.com/video/7681266289940544369",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin Search Users

Douyin search users. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

followers

followers parameter for this endpoint.

user_type

user_type parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/search/users
curl -X GET 'https://socialquery.dev/v1/douyin/search/users?query=%E7%BE%8E%E9%A3%9F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/search/users",
  "data": {
    "id": "string",
    "query": "美食",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Douyin trending. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/douyin/trending
curl -X GET 'https://socialquery.dev/v1/douyin/trending' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "douyin",
  "endpoint": "/v1/douyin/trending",
  "data": {
    "id": "string",
    "query": "/v1/douyin/trending",
    "status": "ok",
    "source": "douyin"
  },
  "credits_used": 25,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

G2 Product

G2 product. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

website_contacts_crawl_mode

website_contacts_crawl_mode parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/g2/product
curl -X GET 'https://socialquery.dev/v1/g2/product?id=postman' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "g2",
  "endpoint": "/v1/g2/product",
  "data": {
    "id": "string",
    "query": "postman",
    "status": "ok",
    "source": "g2"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

G2 Reviews

G2 reviews. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

industry

industry parameter for this endpoint.

keywords

keywords parameter for this endpoint.

region

region parameter for this endpoint.

role

role parameter for this endpoint.

segment

segment parameter for this endpoint.

sort

sort parameter for this endpoint.

stars

stars parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/g2/reviews
curl -X GET 'https://socialquery.dev/v1/g2/reviews?id=postman' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "g2",
  "endpoint": "/v1/g2/reviews",
  "data": {
    "id": "string",
    "query": "postman",
    "status": "ok",
    "source": "g2"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

G2 Category

G2 category. Availability depends on the configured provider route.

Parameters

categoryrequired

category parameter for this endpoint.

page

page parameter for this endpoint.

sort

sort parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/g2/category
curl -X GET 'https://socialquery.dev/v1/g2/category?category=marketing-automation' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "g2",
  "endpoint": "/v1/g2/category",
  "data": {
    "id": "string",
    "query": "marketing-automation",
    "status": "ok",
    "source": "g2"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

G2 Categories

G2 categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/g2/categories
curl -X GET 'https://socialquery.dev/v1/g2/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "g2",
  "endpoint": "/v1/g2/categories",
  "data": {
    "id": "string",
    "query": "/v1/g2/categories",
    "status": "ok",
    "source": "g2"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

G2 Seller

G2 seller. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

handle

handle parameter for this endpoint.

products_page

products_page parameter for this endpoint.

reviews_page

reviews_page parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/g2/seller
curl -X GET 'https://socialquery.dev/v1/g2/seller?id=hubspot' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "g2",
  "endpoint": "/v1/g2/seller",
  "data": {
    "id": "string",
    "query": "hubspot",
    "status": "ok",
    "source": "g2"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

G2 Seller Products

G2 seller products. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/g2/seller/products
curl -X GET 'https://socialquery.dev/v1/g2/seller/products?id=google' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "g2",
  "endpoint": "/v1/g2/seller/products",
  "data": {
    "id": "string",
    "query": "google",
    "status": "ok",
    "source": "g2"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

G2 Product Index

G2 product index. Availability depends on the configured provider route.

Parameters

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/g2/product-index
curl -X GET 'https://socialquery.dev/v1/g2/product-index' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "g2",
  "endpoint": "/v1/g2/product-index",
  "data": {
    "id": "string",
    "query": "10",
    "status": "ok",
    "source": "g2"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Quora search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

time

time parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/quora/search
curl -X GET 'https://socialquery.dev/v1/quora/search?query=learn+programming' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "quora",
  "endpoint": "/v1/quora/search",
  "data": {
    "id": "string",
    "query": "learn programming",
    "status": "ok",
    "source": "quora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Quora Post

Quora post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/quora/post
curl -X GET 'https://socialquery.dev/v1/quora/post?url=https%3A%2F%2Fwww.quora.com%2FWhat-is-the-best-alternative-to-SendGrid-Email-API' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "quora",
  "endpoint": "/v1/quora/post",
  "data": {
    "id": "string",
    "query": "https://www.quora.com/What-is-the-best-alternative-to-SendGrid-Email-API",
    "status": "ok",
    "source": "quora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Quora Answers

Quora answers. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

time

time parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/quora/answers
curl -X GET 'https://socialquery.dev/v1/quora/answers?query=learn+programming' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "quora",
  "endpoint": "/v1/quora/answers",
  "data": {
    "id": "string",
    "query": "learn programming",
    "status": "ok",
    "source": "quora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Quora Posts

Quora posts. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

time

time parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/quora/posts
curl -X GET 'https://socialquery.dev/v1/quora/posts?query=learn+programming' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "quora",
  "endpoint": "/v1/quora/posts",
  "data": {
    "id": "string",
    "query": "learn programming",
    "status": "ok",
    "source": "quora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Quora Profiles

Quora profiles. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

time

time parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/quora/profiles
curl -X GET 'https://socialquery.dev/v1/quora/profiles?query=learn+programming' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "quora",
  "endpoint": "/v1/quora/profiles",
  "data": {
    "id": "string",
    "query": "learn programming",
    "status": "ok",
    "source": "quora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Quora Spaces

Quora spaces. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

time

time parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/quora/spaces
curl -X GET 'https://socialquery.dev/v1/quora/spaces?query=learn+programming' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "quora",
  "endpoint": "/v1/quora/spaces",
  "data": {
    "id": "string",
    "query": "learn programming",
    "status": "ok",
    "source": "quora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Quora Topics

Quora topics. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

time

time parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/quora/topics
curl -X GET 'https://socialquery.dev/v1/quora/topics?query=learn+programming' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "quora",
  "endpoint": "/v1/quora/topics",
  "data": {
    "id": "string",
    "query": "learn programming",
    "status": "ok",
    "source": "quora"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Threads Profile

Threads profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/threads/profile
curl -X GET 'https://socialquery.dev/v1/threads/profile?handle=zuck' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "threads",
  "endpoint": "/v1/threads/profile",
  "data": {
    "id": "string",
    "query": "zuck",
    "status": "ok",
    "source": "threads"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Threads User Posts

Threads user posts. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

since

since parameter for this endpoint.

stop_at_id

stop_at_id parameter for this endpoint.

trim

trim parameter for this endpoint.

limit

limit parameter for this endpoint.

include

include parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/threads/user/posts
curl -X GET 'https://socialquery.dev/v1/threads/user/posts?handle=zuck' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "threads",
  "endpoint": "/v1/threads/user/posts",
  "data": {
    "id": "string",
    "query": "zuck",
    "status": "ok",
    "source": "threads"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Threads Post

Threads post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

trim

trim parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/threads/post
curl -X GET 'https://socialquery.dev/v1/threads/post?url=https%3A%2F%2Fwww.threads.com%2F%40zuck%2Fpost%2FDZpPDXbCeTt' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "threads",
  "endpoint": "/v1/threads/post",
  "data": {
    "id": "string",
    "query": "https://www.threads.com/@zuck/post/DZpPDXbCeTt",
    "status": "ok",
    "source": "threads"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Threads search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

trim

trim parameter for this endpoint.

cursor

cursor parameter for this endpoint.

limit

limit parameter for this endpoint.

expand

expand parameter for this endpoint.

include

include parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

max_pages

max_pages parameter for this endpoint.

seen

seen parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/threads/search
curl -X GET 'https://socialquery.dev/v1/threads/search?query=artificial+intelligence' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "threads",
  "endpoint": "/v1/threads/search",
  "data": {
    "id": "string",
    "query": "artificial intelligence",
    "status": "ok",
    "source": "threads"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Threads Post Comments

Threads post comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

trim

trim parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/threads/post/comments
curl -X GET 'https://socialquery.dev/v1/threads/post/comments?url=https%3A%2F%2Fwww.threads.com%2F%40zuck%2Fpost%2FDZpPDXbCeTt' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "threads",
  "endpoint": "/v1/threads/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.threads.com/@zuck/post/DZpPDXbCeTt",
    "status": "ok",
    "source": "threads"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Threads Search Users

Threads search users. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

include_details

include_details parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/threads/search/users
curl -X GET 'https://socialquery.dev/v1/threads/search/users?query=tech' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "threads",
  "endpoint": "/v1/threads/search/users",
  "data": {
    "id": "string",
    "query": "tech",
    "status": "ok",
    "source": "threads"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Pinterest search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

trim

trim parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/pinterest/search
curl -X GET 'https://socialquery.dev/v1/pinterest/search?query=home+decor+ideas' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/search",
  "data": {
    "id": "string",
    "query": "home decor ideas",
    "status": "ok",
    "source": "pinterest"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Pinterest Pin

Pinterest pin. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

trim

trim parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/pinterest/pin
curl -X GET 'https://socialquery.dev/v1/pinterest/pin?url=https%3A%2F%2Fwww.pinterest.com%2Fpin%2F1234567890%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/pin",
  "data": {
    "id": "string",
    "query": "https://www.pinterest.com/pin/1234567890/",
    "status": "ok",
    "source": "pinterest"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Pinterest Url Stats

Pinterest url stats. Availability depends on the configured provider route.

Parameters

urlsrequired

urls parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/pinterest/url-stats
curl -X GET 'https://socialquery.dev/v1/pinterest/url-stats?urls=https%3A%2F%2Fwww.allrecipes.com%2Frecipe%2F10813%2Fbest-chocolate-chip-cookies%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/url-stats",
  "data": {
    "id": "string",
    "query": "https://www.allrecipes.com/recipe/10813/best-chocolate-chip-cookies/",
    "status": "ok",
    "source": "pinterest"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Pinterest Board

Pinterest board. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

trim

trim parameter for this endpoint.

cursor

cursor parameter for this endpoint.

include

include parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/pinterest/board
curl -X GET 'https://socialquery.dev/v1/pinterest/board?url=https%3A%2F%2Fwww.pinterest.com%2Flizmrodgers%2Fmoms-night%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/board",
  "data": {
    "id": "string",
    "query": "https://www.pinterest.com/lizmrodgers/moms-night/",
    "status": "ok",
    "source": "pinterest"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Pinterest User Boards

Pinterest user boards. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

trim

trim parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/pinterest/user/boards
curl -X GET 'https://socialquery.dev/v1/pinterest/user/boards?handle=pinterest' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/user/boards",
  "data": {
    "id": "string",
    "query": "pinterest",
    "status": "ok",
    "source": "pinterest"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Pinterest trends. Availability depends on the configured provider route.

Parameters

country

country parameter for this endpoint.

type

type parameter for this endpoint.

limit

limit parameter for this endpoint.

include

include parameter for this endpoint.

exclude

exclude parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/pinterest/trends
curl -X GET 'https://socialquery.dev/v1/pinterest/trends' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/trends",
  "data": {
    "id": "string",
    "query": "DE",
    "status": "ok",
    "source": "pinterest"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Shop Product

Tiktokshop product. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

product_id

product_id parameter for this endpoint.

region

region parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktokshop/product
curl -X GET 'https://socialquery.dev/v1/tiktokshop/product?url=https%3A%2F%2Fwww.tiktok.com%2Fshop%2Fpdp%2Fgoli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo%2F1729587769570529799' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktokshop",
  "endpoint": "/v1/tiktokshop/product",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/shop/pdp/goli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo/1729587769570529799",
    "status": "ok",
    "source": "tiktokshop"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Shop Product Reviews

Tiktokshop product reviews. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

product_id

product_id parameter for this endpoint.

region

region parameter for this endpoint.

page

page parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktokshop/product/reviews
curl -X GET 'https://socialquery.dev/v1/tiktokshop/product/reviews?url=https%3A%2F%2Fwww.tiktok.com%2Fshop%2Fpdp%2Fcat-nail-clipper-by-potaroma-adjustable-sizes-built-in-file-safe-for-kittens-cats%2F1731578642912612516' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktokshop",
  "endpoint": "/v1/tiktokshop/product/reviews",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/shop/pdp/cat-nail-clipper-by-potaroma-adjustable-sizes-built-in-file-safe-for-kittens-cats/1731578642912612516",
    "status": "ok",
    "source": "tiktokshop"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Shop Products

Tiktokshop products. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

region

region parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktokshop/products
curl -X GET 'https://socialquery.dev/v1/tiktokshop/products?url=https%3A%2F%2Fwww.tiktok.com%2Fshop%2Fstore%2Fgoli-nutrition%2F7495794203056835079' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktokshop",
  "endpoint": "/v1/tiktokshop/products",
  "data": {
    "id": "string",
    "query": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079",
    "status": "ok",
    "source": "tiktokshop"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tiktokshop search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

region

region parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktokshop/search
curl -X GET 'https://socialquery.dev/v1/tiktokshop/search?query=phone+case' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktokshop",
  "endpoint": "/v1/tiktokshop/search",
  "data": {
    "id": "string",
    "query": "phone case",
    "status": "ok",
    "source": "tiktokshop"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Shop User Showcase

Tiktokshop user showcase. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

region

region parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktokshop/user/showcase
curl -X GET 'https://socialquery.dev/v1/tiktokshop/user/showcase?handle=mrtiktokreviews' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktokshop",
  "endpoint": "/v1/tiktokshop/user/showcase",
  "data": {
    "id": "string",
    "query": "mrtiktokreviews",
    "status": "ok",
    "source": "tiktokshop"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

TikTok Shop Sales

Tiktokshop sales. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

regions

regions parameter for this endpoint.

top

top parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tiktokshop/sales
curl -X GET 'https://socialquery.dev/v1/tiktokshop/sales?query=lip+gloss' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tiktokshop",
  "endpoint": "/v1/tiktokshop/sales",
  "data": {
    "id": "string",
    "query": "lip gloss",
    "status": "ok",
    "source": "tiktokshop"
  },
  "credits_used": 0,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hm search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

limit

limit parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

language

language parameter for this endpoint.

filters

filters parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hm/search
curl -X GET 'https://socialquery.dev/v1/hm/search?query=t-shirts' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hm",
  "endpoint": "/v1/hm/search",
  "data": {
    "id": "string",
    "query": "t-shirts",
    "status": "ok",
    "source": "hm"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hm Search Suggestions

Hm search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hm/search/suggestions
curl -X GET 'https://socialquery.dev/v1/hm/search/suggestions?query=tshirt' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hm",
  "endpoint": "/v1/hm/search/suggestions",
  "data": {
    "id": "string",
    "query": "tshirt",
    "status": "ok",
    "source": "hm"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hm Stores

Hm stores. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hm/stores
curl -X GET 'https://socialquery.dev/v1/hm/stores?query=us' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hm",
  "endpoint": "/v1/hm/stores",
  "data": {
    "id": "string",
    "query": "us",
    "status": "ok",
    "source": "hm"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hm Countries

Hm countries. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hm/countries
curl -X GET 'https://socialquery.dev/v1/hm/countries' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hm",
  "endpoint": "/v1/hm/countries",
  "data": {
    "id": "string",
    "query": "/v1/hm/countries",
    "status": "ok",
    "source": "hm"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hm Categories

Hm categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hm/categories
curl -X GET 'https://socialquery.dev/v1/hm/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hm",
  "endpoint": "/v1/hm/categories",
  "data": {
    "id": "string",
    "query": "/v1/hm/categories",
    "status": "ok",
    "source": "hm"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hm Product Suppliers

Hm product suppliers. Availability depends on the configured provider route.

Parameters

product_idrequired

product_id parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hm/product/suppliers
curl -X GET 'https://socialquery.dev/v1/hm/product/suppliers?product_id=0963662139' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hm",
  "endpoint": "/v1/hm/product/suppliers",
  "data": {
    "id": "string",
    "query": "0963662139",
    "status": "ok",
    "source": "hm"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Spotify Artist

Spotify artist. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/spotify/artist
curl -X GET 'https://socialquery.dev/v1/spotify/artist?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "spotify",
  "endpoint": "/v1/spotify/artist",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "spotify"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Spotify Track

Spotify track. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/spotify/track
curl -X GET 'https://socialquery.dev/v1/spotify/track?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "spotify",
  "endpoint": "/v1/spotify/track",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "spotify"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Spotify Album

Spotify album. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/spotify/album
curl -X GET 'https://socialquery.dev/v1/spotify/album?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "spotify",
  "endpoint": "/v1/spotify/album",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "spotify"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Spotify search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/spotify/search
curl -X GET 'https://socialquery.dev/v1/spotify/search?query=my+first+million' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "spotify",
  "endpoint": "/v1/spotify/search",
  "data": {
    "id": "string",
    "query": "my first million",
    "status": "ok",
    "source": "spotify"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Spotify Podcast

Spotify podcast. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/spotify/podcast
curl -X GET 'https://socialquery.dev/v1/spotify/podcast?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "spotify",
  "endpoint": "/v1/spotify/podcast",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "spotify"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Spotify Podcast Episodes

Spotify podcast episodes. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/spotify/podcast/episodes
curl -X GET 'https://socialquery.dev/v1/spotify/podcast/episodes?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "spotify",
  "endpoint": "/v1/spotify/podcast/episodes",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "spotify"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Xiaohongshu search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

sort

sort parameter for this endpoint.

type

type parameter for this endpoint.

published

published parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/xiaohongshu/search
curl -X GET 'https://socialquery.dev/v1/xiaohongshu/search?query=%E6%8A%A4%E8%82%A4' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "xiaohongshu",
  "endpoint": "/v1/xiaohongshu/search",
  "data": {
    "id": "string",
    "query": "护肤",
    "status": "ok",
    "source": "xiaohongshu"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Xiaohongshu trending. Availability depends on the configured provider route.

Parameters

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/xiaohongshu/trending
curl -X GET 'https://socialquery.dev/v1/xiaohongshu/trending' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "xiaohongshu",
  "endpoint": "/v1/xiaohongshu/trending",
  "data": {
    "id": "string",
    "query": "10",
    "status": "ok",
    "source": "xiaohongshu"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Xiaohongshu Profile

Xiaohongshu profile. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

id

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/xiaohongshu/profile
curl -X GET 'https://socialquery.dev/v1/xiaohongshu/profile?url=https%3A%2F%2Fwww.xiaohongshu.com%2Fuser%2Fprofile%2F6a59f257000000000f03b000' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "xiaohongshu",
  "endpoint": "/v1/xiaohongshu/profile",
  "data": {
    "id": "string",
    "query": "https://www.xiaohongshu.com/user/profile/6a59f257000000000f03b000",
    "status": "ok",
    "source": "xiaohongshu"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Xiaohongshu Profile Posts

Xiaohongshu profile posts. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

id

id parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/xiaohongshu/profile/posts
curl -X GET 'https://socialquery.dev/v1/xiaohongshu/profile/posts?url=https%3A%2F%2Fwww.xiaohongshu.com%2Fuser%2Fprofile%2F6a59f257000000000f03b000' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "xiaohongshu",
  "endpoint": "/v1/xiaohongshu/profile/posts",
  "data": {
    "id": "string",
    "query": "https://www.xiaohongshu.com/user/profile/6a59f257000000000f03b000",
    "status": "ok",
    "source": "xiaohongshu"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Xiaohongshu Post

Xiaohongshu post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/xiaohongshu/post
curl -X GET 'https://socialquery.dev/v1/xiaohongshu/post?url=https%3A%2F%2Fwww.xiaohongshu.com%2Fexplore%2F6aac8143000000002a007389' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "xiaohongshu",
  "endpoint": "/v1/xiaohongshu/post",
  "data": {
    "id": "string",
    "query": "https://www.xiaohongshu.com/explore/6aac8143000000002a007389",
    "status": "ok",
    "source": "xiaohongshu"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Xiaohongshu Post Comments

Xiaohongshu post comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

sort

sort parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/xiaohongshu/post/comments
curl -X GET 'https://socialquery.dev/v1/xiaohongshu/post/comments?url=https%3A%2F%2Fwww.xiaohongshu.com%2Fexplore%2F6aac8143000000002a007389' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "xiaohongshu",
  "endpoint": "/v1/xiaohongshu/post/comments",
  "data": {
    "id": "string",
    "query": "https://www.xiaohongshu.com/explore/6aac8143000000002a007389",
    "status": "ok",
    "source": "xiaohongshu"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Shopping product search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

depth

depth parameter for this endpoint.

price_min

price_min parameter for this endpoint.

price_max

price_max parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_shopping/product-search
curl -X GET 'https://socialquery.dev/v1/google_shopping/product-search?query=wireless+earbuds' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_shopping",
  "endpoint": "/v1/google_shopping/product-search",
  "data": {
    "id": "string",
    "query": "wireless earbuds",
    "status": "ok",
    "source": "google_shopping"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Shopping Product

Google Shopping product. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

gid

gid parameter for this endpoint.

data_docid

data_docid parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_shopping/product
curl -X GET 'https://socialquery.dev/v1/google_shopping/product?product_id=1749519698216963169' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_shopping",
  "endpoint": "/v1/google_shopping/product",
  "data": {
    "id": "string",
    "query": "1749519698216963169",
    "status": "ok",
    "source": "google_shopping"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Shopping Reviews

Google Shopping reviews. Availability depends on the configured provider route.

Parameters

gidrequired

gid parameter for this endpoint.

product_id

product_id parameter for this endpoint.

data_docid

data_docid parameter for this endpoint.

depth

depth parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_shopping/reviews
curl -X GET 'https://socialquery.dev/v1/google_shopping/reviews?gid=3591805395819257241' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_shopping",
  "endpoint": "/v1/google_shopping/reviews",
  "data": {
    "id": "string",
    "query": "3591805395819257241",
    "status": "ok",
    "source": "google_shopping"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Shopping Sellers

Google Shopping sellers. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

gid

gid parameter for this endpoint.

data_docid

data_docid parameter for this endpoint.

country

country parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_shopping/sellers
curl -X GET 'https://socialquery.dev/v1/google_shopping/sellers?product_id=1749519698216963169' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_shopping",
  "endpoint": "/v1/google_shopping/sellers",
  "data": {
    "id": "string",
    "query": "1749519698216963169",
    "status": "ok",
    "source": "google_shopping"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Shopping Price History

Google Shopping price history. Availability depends on the configured provider route.

Parameters

product_idrequired

product_id parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_shopping/price-history
curl -X GET 'https://socialquery.dev/v1/google_shopping/price-history?product_id=catalogid%3A7310953537322941042%2Cproductid%3A2695666608789071335' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_shopping",
  "endpoint": "/v1/google_shopping/price-history",
  "data": {
    "id": "string",
    "query": "catalogid:7310953537322941042,productid:2695666608789071335",
    "status": "ok",
    "source": "google_shopping"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Walmart Product

Walmart product. Availability depends on the configured provider route.

Parameters

product_idrequired

product_id parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/walmart/product
curl -X GET 'https://socialquery.dev/v1/walmart/product?product_id=17835006350' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "walmart",
  "endpoint": "/v1/walmart/product",
  "data": {
    "id": "string",
    "query": "17835006350",
    "status": "ok",
    "source": "walmart"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Walmart Reviews

Walmart reviews. Availability depends on the configured provider route.

Parameters

product_idrequired

product_id parameter for this endpoint.

page

page parameter for this endpoint.

limit

limit parameter for this endpoint.

sort

sort parameter for this endpoint.

rating

rating parameter for this endpoint.

country

country parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/walmart/reviews
curl -X GET 'https://socialquery.dev/v1/walmart/reviews?product_id=17835006350' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "walmart",
  "endpoint": "/v1/walmart/reviews",
  "data": {
    "id": "string",
    "query": "17835006350",
    "status": "ok",
    "source": "walmart"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Walmart search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

zip_code

zip_code parameter for this endpoint.

state

state parameter for this endpoint.

store_id

store_id parameter for this endpoint.

facet

facet parameter for this endpoint.

country

country parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/walmart/search
curl -X GET 'https://socialquery.dev/v1/walmart/search?query=airpods+pro' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "walmart",
  "endpoint": "/v1/walmart/search",
  "data": {
    "id": "string",
    "query": "airpods pro",
    "status": "ok",
    "source": "walmart"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Walmart Category

Walmart category. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

page

page parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

zip_code

zip_code parameter for this endpoint.

state

state parameter for this endpoint.

store_id

store_id parameter for this endpoint.

facet

facet parameter for this endpoint.

country

country parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/walmart/category
curl -X GET 'https://socialquery.dev/v1/walmart/category?category_id=3944' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "walmart",
  "endpoint": "/v1/walmart/category",
  "data": {
    "id": "string",
    "query": "3944",
    "status": "ok",
    "source": "walmart"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Walmart Offers

Walmart offers. Availability depends on the configured provider route.

Parameters

product_idrequired

product_id parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/walmart/offers
curl -X GET 'https://socialquery.dev/v1/walmart/offers?product_id=17835006350' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "walmart",
  "endpoint": "/v1/walmart/offers",
  "data": {
    "id": "string",
    "query": "17835006350",
    "status": "ok",
    "source": "walmart"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Target Product

Target product. Availability depends on the configured provider route.

Parameters

tcinrequired

tcin parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/target/product
curl -X GET 'https://socialquery.dev/v1/target/product?tcin=92148487' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "target",
  "endpoint": "/v1/target/product",
  "data": {
    "id": "string",
    "query": "92148487",
    "status": "ok",
    "source": "target"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Target Reviews

Target reviews. Availability depends on the configured provider route.

Parameters

tcinrequired

tcin parameter for this endpoint.

page

page parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/target/reviews
curl -X GET 'https://socialquery.dev/v1/target/reviews?tcin=92146817' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "target",
  "endpoint": "/v1/target/reviews",
  "data": {
    "id": "string",
    "query": "92146817",
    "status": "ok",
    "source": "target"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Target Category

Target category. Availability depends on the configured provider route.

Parameters

category_idrequired

category_id parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/target/category
curl -X GET 'https://socialquery.dev/v1/target/category?category_id=hz89j' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "target",
  "endpoint": "/v1/target/category",
  "data": {
    "id": "string",
    "query": "hz89j",
    "status": "ok",
    "source": "target"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Target Categories

Target categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/target/categories
curl -X GET 'https://socialquery.dev/v1/target/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "target",
  "endpoint": "/v1/target/categories",
  "data": {
    "id": "string",
    "query": "/v1/target/categories",
    "status": "ok",
    "source": "target"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Target Stores

Target stores. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/target/stores
curl -X GET 'https://socialquery.dev/v1/target/stores?query=10001' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "target",
  "endpoint": "/v1/target/stores",
  "data": {
    "id": "string",
    "query": "10001",
    "status": "ok",
    "source": "target"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kohls search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

limit

limit parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

filters

filters parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kohls/search
curl -X GET 'https://socialquery.dev/v1/kohls/search?query=jeans' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kohls",
  "endpoint": "/v1/kohls/search",
  "data": {
    "id": "string",
    "query": "jeans",
    "status": "ok",
    "source": "kohls"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kohls Reviews

Kohls reviews. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

limit

limit parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kohls/reviews
curl -X GET 'https://socialquery.dev/v1/kohls/reviews?product_id=1695762' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kohls",
  "endpoint": "/v1/kohls/reviews",
  "data": {
    "id": "string",
    "query": "1695762",
    "status": "ok",
    "source": "kohls"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kohls Questions

Kohls questions. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

limit

limit parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kohls/questions
curl -X GET 'https://socialquery.dev/v1/kohls/questions?product_id=1695762' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kohls",
  "endpoint": "/v1/kohls/questions",
  "data": {
    "id": "string",
    "query": "1695762",
    "status": "ok",
    "source": "kohls"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kohls Stores

Kohls stores. Availability depends on the configured provider route.

Parameters

location_coordinate

location_coordinate parameter for this endpoint.

latitude

latitude parameter for this endpoint.

longitude

longitude parameter for this endpoint.

radius

radius parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kohls/stores
curl -X GET 'https://socialquery.dev/v1/kohls/stores?location_coordinate=40.758%2C-73.9855' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kohls",
  "endpoint": "/v1/kohls/stores",
  "data": {
    "id": "string",
    "query": "40.758,-73.9855",
    "status": "ok",
    "source": "kohls"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kohls Categories

Kohls categories. Availability depends on the configured provider route.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kohls/categories
curl -X GET 'https://socialquery.dev/v1/kohls/categories' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kohls",
  "endpoint": "/v1/kohls/categories",
  "data": {
    "id": "string",
    "query": "/v1/kohls/categories",
    "status": "ok",
    "source": "kohls"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Yelp Business Info

Yelp business info. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/yelp/business/info
curl -X GET 'https://socialquery.dev/v1/yelp/business/info?id=zj8Lq1T8KIC5zwFief15jg' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "yelp",
  "endpoint": "/v1/yelp/business/info",
  "data": {
    "id": "string",
    "query": "zj8Lq1T8KIC5zwFief15jg",
    "status": "ok",
    "source": "yelp"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Yelp Business Reviews

Yelp business reviews. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/yelp/business/reviews
curl -X GET 'https://socialquery.dev/v1/yelp/business/reviews?id=zj8Lq1T8KIC5zwFief15jg' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "yelp",
  "endpoint": "/v1/yelp/business/reviews",
  "data": {
    "id": "string",
    "query": "zj8Lq1T8KIC5zwFief15jg",
    "status": "ok",
    "source": "yelp"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Yelp search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

locationrequired

location parameter for this endpoint.

cursor

cursor parameter for this endpoint.

sort

sort parameter for this endpoint.

ads

ads parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/yelp/search
curl -X GET 'https://socialquery.dev/v1/yelp/search?query=Pizza&location=New+York%2C+NY' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "yelp",
  "endpoint": "/v1/yelp/search",
  "data": {
    "id": "string",
    "query": "Pizza",
    "status": "ok",
    "source": "yelp"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Yelp Search Full

Yelp search full. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

locationrequired

location parameter for this endpoint.

cursor

cursor parameter for this endpoint.

sort

sort parameter for this endpoint.

ads

ads parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/yelp/search/full
curl -X GET 'https://socialquery.dev/v1/yelp/search/full?query=Pizza&location=New+York%2C+NY' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "yelp",
  "endpoint": "/v1/yelp/search/full",
  "data": {
    "id": "string",
    "query": "Pizza",
    "status": "ok",
    "source": "yelp"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Yelp Search Suggestions

Yelp search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

locationrequired

location parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/yelp/search/suggestions
curl -X GET 'https://socialquery.dev/v1/yelp/search/suggestions?query=Pizza&location=New+York%2C+NY' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "yelp",
  "endpoint": "/v1/yelp/search/suggestions",
  "data": {
    "id": "string",
    "query": "Pizza",
    "status": "ok",
    "source": "yelp"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Rumble search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/rumble/search
curl -X GET 'https://socialquery.dev/v1/rumble/search?query=funny+cats' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "rumble",
  "endpoint": "/v1/rumble/search",
  "data": {
    "id": "string",
    "query": "funny cats",
    "status": "ok",
    "source": "rumble"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Rumble Channel Videos

Rumble channel videos. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/rumble/channel/videos
curl -X GET 'https://socialquery.dev/v1/rumble/channel/videos?handle=CuteCats223' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "rumble",
  "endpoint": "/v1/rumble/channel/videos",
  "data": {
    "id": "string",
    "query": "CuteCats223",
    "status": "ok",
    "source": "rumble"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Rumble Video

Rumble video. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/rumble/video
curl -X GET 'https://socialquery.dev/v1/rumble/video?url=https%3A%2F%2Frumble.com%2Fv79xhhm-discovery-example.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "rumble",
  "endpoint": "/v1/rumble/video",
  "data": {
    "id": "string",
    "query": "https://rumble.com/v79xhhm-discovery-example.html",
    "status": "ok",
    "source": "rumble"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Rumble Video Transcript

Rumble video transcript. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/rumble/video/transcript
curl -X GET 'https://socialquery.dev/v1/rumble/video/transcript?url=https%3A%2F%2Frumble.com%2Fv784xoi-president-donald-j.-trump-and-secwar-pete-hegseth-hold-a-press-conference-a.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "rumble",
  "endpoint": "/v1/rumble/video/transcript",
  "data": {
    "id": "string",
    "query": "https://rumble.com/v784xoi-president-donald-j.-trump-and-secwar-pete-hegseth-hold-a-press-conference-a.html",
    "status": "ok",
    "source": "rumble"
  },
  "credits_used": 10,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Rumble Video Comments

Rumble video comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/rumble/video/comments
curl -X GET 'https://socialquery.dev/v1/rumble/video/comments?url=https%3A%2F%2Frumble.com%2Fv792vns-example.html' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "rumble",
  "endpoint": "/v1/rumble/video/comments",
  "data": {
    "id": "string",
    "query": "https://rumble.com/v792vns-example.html",
    "status": "ok",
    "source": "rumble"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Apple Music search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

type

type parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/apple_music/search
curl -X GET 'https://socialquery.dev/v1/apple_music/search?query=taylor+swift' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "apple_music",
  "endpoint": "/v1/apple_music/search",
  "data": {
    "id": "string",
    "query": "taylor swift",
    "status": "ok",
    "source": "apple_music"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Apple Music Artist

Apple Music artist. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/apple_music/artist
curl -X GET 'https://socialquery.dev/v1/apple_music/artist?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "apple_music",
  "endpoint": "/v1/apple_music/artist",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "apple_music"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Apple Music Album

Apple Music album. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/apple_music/album
curl -X GET 'https://socialquery.dev/v1/apple_music/album?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "apple_music",
  "endpoint": "/v1/apple_music/album",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "apple_music"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Apple Music Track

Apple Music track. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/apple_music/track
curl -X GET 'https://socialquery.dev/v1/apple_music/track?id=1234567890' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "apple_music",
  "endpoint": "/v1/apple_music/track",
  "data": {
    "id": "string",
    "query": "1234567890",
    "status": "ok",
    "source": "apple_music"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Apple Music Charts

Apple Music charts. Availability depends on the configured provider route.

Parameters

country

country parameter for this endpoint.

type

type parameter for this endpoint.

limit

limit parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/apple_music/charts
curl -X GET 'https://socialquery.dev/v1/apple_music/charts' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "apple_music",
  "endpoint": "/v1/apple_music/charts",
  "data": {
    "id": "string",
    "query": "de",
    "status": "ok",
    "source": "apple_music"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Economy Consumer Spend

Economy consumer spend. Availability depends on the configured provider route.

Parameters

country_coderequired

country_code parameter for this endpoint.

category

category parameter for this endpoint.

from_year

from_year parameter for this endpoint.

to_year

to_year parameter for this endpoint.

unit

unit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/economy/consumer-spend
curl -X GET 'https://socialquery.dev/v1/economy/consumer-spend?country_code=DE%2CFR' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "economy",
  "endpoint": "/v1/economy/consumer-spend",
  "data": {
    "id": "string",
    "query": "DE,FR",
    "status": "ok",
    "source": "economy"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Economy Tourism Spend

Economy tourism spend. Availability depends on the configured provider route.

Parameters

country_coderequired

country_code parameter for this endpoint.

category

category parameter for this endpoint.

purpose

purpose parameter for this endpoint.

destination

destination parameter for this endpoint.

measure

measure parameter for this endpoint.

from_year

from_year parameter for this endpoint.

to_year

to_year parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/economy/tourism-spend
curl -X GET 'https://socialquery.dev/v1/economy/tourism-spend?country_code=DE%2CFR' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "economy",
  "endpoint": "/v1/economy/tourism-spend",
  "data": {
    "id": "string",
    "query": "DE,FR",
    "status": "ok",
    "source": "economy"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Economy Government Spend

Economy government spend. Availability depends on the configured provider route.

Parameters

naics

naics parameter for this endpoint.

psc

psc parameter for this endpoint.

keyword

keyword parameter for this endpoint.

from_date

from_date parameter for this endpoint.

to_date

to_date parameter for this endpoint.

geo

geo parameter for this endpoint.

scope

scope parameter for this endpoint.

award_type

award_type parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/economy/government-spend
curl -X GET 'https://socialquery.dev/v1/economy/government-spend' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "economy",
  "endpoint": "/v1/economy/government-spend",
  "data": {
    "id": "string",
    "query": "4811",
    "status": "ok",
    "source": "economy"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Economy Government Contracts

Economy government contracts. Availability depends on the configured provider route.

Parameters

recipient

recipient parameter for this endpoint.

keyword

keyword parameter for this endpoint.

naics

naics parameter for this endpoint.

psc

psc parameter for this endpoint.

from_date

from_date parameter for this endpoint.

to_date

to_date parameter for this endpoint.

type

type parameter for this endpoint.

sort

sort parameter for this endpoint.

order

order parameter for this endpoint.

limit

limit parameter for this endpoint.

page

page parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/economy/government-contracts
curl -X GET 'https://socialquery.dev/v1/economy/government-contracts' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "economy",
  "endpoint": "/v1/economy/government-contracts",
  "data": {
    "id": "string",
    "query": "",
    "status": "ok",
    "source": "economy"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Economy Imports

Economy imports. Availability depends on the configured provider route.

Parameters

companyrequired

company parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/economy/imports
curl -X GET 'https://socialquery.dev/v1/economy/imports?company=Nike' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "economy",
  "endpoint": "/v1/economy/imports",
  "data": {
    "id": "string",
    "query": "Nike",
    "status": "ok",
    "source": "economy"
  },
  "credits_used": 20,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Twitch Profile

Twitch profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitch/profile
curl -X GET 'https://socialquery.dev/v1/twitch/profile?handle=ninja' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitch",
  "endpoint": "/v1/twitch/profile",
  "data": {
    "id": "string",
    "query": "ninja",
    "status": "ok",
    "source": "twitch"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Twitch Clip

Twitch clip. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitch/clip
curl -X GET 'https://socialquery.dev/v1/twitch/clip?url=https%3A%2F%2Fwww.twitch.tv%2Fninja%2Fclip%2FExampleClipSlug' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitch",
  "endpoint": "/v1/twitch/clip",
  "data": {
    "id": "string",
    "query": "https://www.twitch.tv/ninja/clip/ExampleClipSlug",
    "status": "ok",
    "source": "twitch"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Twitch User Videos

Twitch user videos. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

filter_by

filter_by parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitch/user/videos
curl -X GET 'https://socialquery.dev/v1/twitch/user/videos?handle=ishowspeed' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitch",
  "endpoint": "/v1/twitch/user/videos",
  "data": {
    "id": "string",
    "query": "ishowspeed",
    "status": "ok",
    "source": "twitch"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Twitch User Schedule

Twitch user schedule. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/twitch/user/schedule
curl -X GET 'https://socialquery.dev/v1/twitch/user/schedule?handle=kaicenat' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "twitch",
  "endpoint": "/v1/twitch/user/schedule",
  "data": {
    "id": "string",
    "query": "kaicenat",
    "status": "ok",
    "source": "twitch"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Home Depot Product

Home Depot product. Availability depends on the configured provider route.

Parameters

item_id

item_id parameter for this endpoint.

url

url parameter for this endpoint.

store_id

store_id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/home_depot/product
curl -X GET 'https://socialquery.dev/v1/home_depot/product?item_id=326680222' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "home_depot",
  "endpoint": "/v1/home_depot/product",
  "data": {
    "id": "string",
    "query": "326680222",
    "status": "ok",
    "source": "home_depot"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Home Depot Reviews

Home Depot reviews. Availability depends on the configured provider route.

Parameters

item_idrequired

item_id parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/home_depot/reviews
curl -X GET 'https://socialquery.dev/v1/home_depot/reviews?item_id=326680222' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "home_depot",
  "endpoint": "/v1/home_depot/reviews",
  "data": {
    "id": "string",
    "query": "326680222",
    "status": "ok",
    "source": "home_depot"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Home Depot search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

page

page parameter for this endpoint.

store_id

store_id parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/home_depot/search
curl -X GET 'https://socialquery.dev/v1/home_depot/search?query=drill' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "home_depot",
  "endpoint": "/v1/home_depot/search",
  "data": {
    "id": "string",
    "query": "drill",
    "status": "ok",
    "source": "home_depot"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Home Depot Stores

Home Depot stores. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/home_depot/stores
curl -X GET 'https://socialquery.dev/v1/home_depot/stores?query=95032' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "home_depot",
  "endpoint": "/v1/home_depot/stores",
  "data": {
    "id": "string",
    "query": "95032",
    "status": "ok",
    "source": "home_depot"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Etsy Product

Etsy product. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/etsy/product
curl -X GET 'https://socialquery.dev/v1/etsy/product?product_id=1215970085' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "etsy",
  "endpoint": "/v1/etsy/product",
  "data": {
    "id": "string",
    "query": "1215970085",
    "status": "ok",
    "source": "etsy"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Etsy Shop Products

Etsy shop products. Availability depends on the configured provider route.

Parameters

id

id parameter for this endpoint.

url

url parameter for this endpoint.

page

page parameter for this endpoint.

limit

limit parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

currency

currency parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/etsy/shop/products
curl -X GET 'https://socialquery.dev/v1/etsy/shop/products?id=AceElegance' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "etsy",
  "endpoint": "/v1/etsy/shop/products",
  "data": {
    "id": "string",
    "query": "AceElegance",
    "status": "ok",
    "source": "etsy"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Etsy Product Similar

Etsy product similar. Availability depends on the configured provider route.

Parameters

product_id

product_id parameter for this endpoint.

url

url parameter for this endpoint.

country

country parameter for this endpoint.

currency

currency parameter for this endpoint.

language

language parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/etsy/product/similar
curl -X GET 'https://socialquery.dev/v1/etsy/product/similar?product_id=1215970085' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "etsy",
  "endpoint": "/v1/etsy/product/similar",
  "data": {
    "id": "string",
    "query": "1215970085",
    "status": "ok",
    "source": "etsy"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Etsy Search Suggestions

Etsy search suggestions. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/etsy/search/suggestions
curl -X GET 'https://socialquery.dev/v1/etsy/search/suggestions?query=leather' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "etsy",
  "endpoint": "/v1/etsy/search/suggestions",
  "data": {
    "id": "string",
    "query": "leather",
    "status": "ok",
    "source": "etsy"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hackernews search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

tags

tags parameter for this endpoint.

numericFilters

numericFilters parameter for this endpoint.

hitsPerPage

hitsPerPage parameter for this endpoint.

page

page parameter for this endpoint.

relevance

relevance parameter for this endpoint.

relevance_threshold

relevance_threshold parameter for this endpoint.

relevant_to

relevant_to parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

label

label parameter for this endpoint.

exclude

exclude parameter for this endpoint.

brand

brand parameter for this endpoint.

brand_description

brand_description parameter for this endpoint.

offer

offer parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hackernews/search
curl -X GET 'https://socialquery.dev/v1/hackernews/search?query=claude+code' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hackernews",
  "endpoint": "/v1/hackernews/search",
  "data": {
    "id": "string",
    "query": "claude code",
    "status": "ok",
    "source": "hackernews"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hacker News Story

Hackernews story. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hackernews/story
curl -X GET 'https://socialquery.dev/v1/hackernews/story?id=8863' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hackernews",
  "endpoint": "/v1/hackernews/story",
  "data": {
    "id": "string",
    "query": "8863",
    "status": "ok",
    "source": "hackernews"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hacker News Story Comments

Hackernews story comments. Availability depends on the configured provider route.

Parameters

idrequired

id parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hackernews/story/comments
curl -X GET 'https://socialquery.dev/v1/hackernews/story/comments?id=8863' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hackernews",
  "endpoint": "/v1/hackernews/story/comments",
  "data": {
    "id": "string",
    "query": "8863",
    "status": "ok",
    "source": "hackernews"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Hacker News Profile

Hackernews profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/hackernews/profile
curl -X GET 'https://socialquery.dev/v1/hackernews/profile?handle=pg' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "hackernews",
  "endpoint": "/v1/hackernews/profile",
  "data": {
    "id": "string",
    "query": "pg",
    "status": "ok",
    "source": "hackernews"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tavily search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

search_depth

search_depth parameter for this endpoint.

topic

topic parameter for this endpoint.

time_range

time_range parameter for this endpoint.

max_results

max_results parameter for this endpoint.

chunks_per_source

chunks_per_source parameter for this endpoint.

include_images

include_images parameter for this endpoint.

include_image_descriptions

include_image_descriptions parameter for this endpoint.

include_answer

include_answer parameter for this endpoint.

include_raw_content

include_raw_content parameter for this endpoint.

include_domains

include_domains parameter for this endpoint.

exclude_domains

exclude_domains parameter for this endpoint.

country

country parameter for this endpoint.

start_date

start_date parameter for this endpoint.

end_date

end_date parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tavily/search
curl -X GET 'https://socialquery.dev/v1/tavily/search?query=claude+opus+4.7+release+notes' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tavily",
  "endpoint": "/v1/tavily/search",
  "data": {
    "id": "string",
    "query": "claude opus 4.7 release notes",
    "status": "ok",
    "source": "tavily"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tavily Extract

Tavily extract. Availability depends on the configured provider route.

Parameters

urlsrequired

urls parameter for this endpoint.

extract_depth

extract_depth parameter for this endpoint.

format

format parameter for this endpoint.

include_images

include_images parameter for this endpoint.

include_favicon

include_favicon parameter for this endpoint.

timeout

timeout parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tavily/extract
curl -X GET 'https://socialquery.dev/v1/tavily/extract?urls=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FLionel_Messi' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tavily",
  "endpoint": "/v1/tavily/extract",
  "data": {
    "id": "string",
    "query": "https://en.wikipedia.org/wiki/Lionel_Messi",
    "status": "ok",
    "source": "tavily"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tavily Map

Tavily map. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

max_depth

max_depth parameter for this endpoint.

max_breadth

max_breadth parameter for this endpoint.

limit

limit parameter for this endpoint.

instructions

instructions parameter for this endpoint.

select_paths

select_paths parameter for this endpoint.

select_domains

select_domains parameter for this endpoint.

exclude_paths

exclude_paths parameter for this endpoint.

exclude_domains

exclude_domains parameter for this endpoint.

allow_external

allow_external parameter for this endpoint.

timeout

timeout parameter for this endpoint.

categories

categories parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tavily/map
curl -X GET 'https://socialquery.dev/v1/tavily/map?url=https%3A%2F%2Fdocs.tavily.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tavily",
  "endpoint": "/v1/tavily/map",
  "data": {
    "id": "string",
    "query": "https://docs.tavily.com",
    "status": "ok",
    "source": "tavily"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Tavily Crawl

Tavily crawl. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

max_depth

max_depth parameter for this endpoint.

max_breadth

max_breadth parameter for this endpoint.

limit

limit parameter for this endpoint.

instructions

instructions parameter for this endpoint.

select_paths

select_paths parameter for this endpoint.

select_domains

select_domains parameter for this endpoint.

exclude_paths

exclude_paths parameter for this endpoint.

exclude_domains

exclude_domains parameter for this endpoint.

allow_external

allow_external parameter for this endpoint.

extract_depth

extract_depth parameter for this endpoint.

format

format parameter for this endpoint.

categories

categories parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/tavily/crawl
curl -X GET 'https://socialquery.dev/v1/tavily/crawl?url=https%3A%2F%2Fdocs.tavily.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "tavily",
  "endpoint": "/v1/tavily/crawl",
  "data": {
    "id": "string",
    "query": "https://docs.tavily.com",
    "status": "ok",
    "source": "tavily"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Bluesky Profile

Bluesky profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/bluesky/profile
curl -X GET 'https://socialquery.dev/v1/bluesky/profile?handle=espn.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "bluesky",
  "endpoint": "/v1/bluesky/profile",
  "data": {
    "id": "string",
    "query": "espn.com",
    "status": "ok",
    "source": "bluesky"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Bluesky User Posts

Bluesky user posts. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/bluesky/user/posts
curl -X GET 'https://socialquery.dev/v1/bluesky/user/posts?handle=espn.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "bluesky",
  "endpoint": "/v1/bluesky/user/posts",
  "data": {
    "id": "string",
    "query": "espn.com",
    "status": "ok",
    "source": "bluesky"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Bluesky Post

Bluesky post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/bluesky/post
curl -X GET 'https://socialquery.dev/v1/bluesky/post?url=https%3A%2F%2Fbsky.app%2Fprofile%2Fespn.com%2Fpost%2F3lqdfq7fkvm2g' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "bluesky",
  "endpoint": "/v1/bluesky/post",
  "data": {
    "id": "string",
    "query": "https://bsky.app/profile/espn.com/post/3lqdfq7fkvm2g",
    "status": "ok",
    "source": "bluesky"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Bluesky search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

sort

sort parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

lang

lang parameter for this endpoint.

author

author parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/bluesky/search
curl -X GET 'https://socialquery.dev/v1/bluesky/search?query=espresso' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "bluesky",
  "endpoint": "/v1/bluesky/search",
  "data": {
    "id": "string",
    "query": "espresso",
    "status": "ok",
    "source": "bluesky"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Truthsocial Profile

Truthsocial profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/truthsocial/profile
curl -X GET 'https://socialquery.dev/v1/truthsocial/profile?handle=realDonaldTrump' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "truthsocial",
  "endpoint": "/v1/truthsocial/profile",
  "data": {
    "id": "string",
    "query": "realDonaldTrump",
    "status": "ok",
    "source": "truthsocial"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Truthsocial User Posts

Truthsocial user posts. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

user_id

user_id parameter for this endpoint.

next_max_id

next_max_id parameter for this endpoint.

trim

trim parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/truthsocial/user/posts
curl -X GET 'https://socialquery.dev/v1/truthsocial/user/posts?handle=realDonaldTrump' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "truthsocial",
  "endpoint": "/v1/truthsocial/user/posts",
  "data": {
    "id": "string",
    "query": "realDonaldTrump",
    "status": "ok",
    "source": "truthsocial"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Truthsocial Post

Truthsocial post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/truthsocial/post
curl -X GET 'https://socialquery.dev/v1/truthsocial/post?url=https%3A%2F%2Ftruthsocial.com%2F%40realDonaldTrump%2Fposts%2F123456789' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "truthsocial",
  "endpoint": "/v1/truthsocial/post",
  "data": {
    "id": "string",
    "query": "https://truthsocial.com/@realDonaldTrump/posts/123456789",
    "status": "ok",
    "source": "truthsocial"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Telegram Profile

Telegram profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/telegram/profile
curl -X GET 'https://socialquery.dev/v1/telegram/profile?handle=telegram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "telegram",
  "endpoint": "/v1/telegram/profile",
  "data": {
    "id": "string",
    "query": "telegram",
    "status": "ok",
    "source": "telegram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Telegram Profile Posts

Telegram profile posts. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/telegram/profile/posts
curl -X GET 'https://socialquery.dev/v1/telegram/profile/posts?handle=telegram' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "telegram",
  "endpoint": "/v1/telegram/profile/posts",
  "data": {
    "id": "string",
    "query": "telegram",
    "status": "ok",
    "source": "telegram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Telegram Post

Telegram post. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/telegram/post
curl -X GET 'https://socialquery.dev/v1/telegram/post?url=https%3A%2F%2Ft.me%2Fdurov%2F546' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "telegram",
  "endpoint": "/v1/telegram/post",
  "data": {
    "id": "string",
    "query": "https://t.me/durov/546",
    "status": "ok",
    "source": "telegram"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kwai Profile

Kwai profile. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kwai/profile
curl -X GET 'https://socialquery.dev/v1/kwai/profile?handle=KwaiBrasilOficial' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kwai",
  "endpoint": "/v1/kwai/profile",
  "data": {
    "id": "string",
    "query": "KwaiBrasilOficial",
    "status": "ok",
    "source": "kwai"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kwai User Posts

Kwai user posts. Availability depends on the configured provider route.

Parameters

handle

handle parameter for this endpoint.

url

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

count

count parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kwai/user/posts
curl -X GET 'https://socialquery.dev/v1/kwai/user/posts?handle=KwaiBrasilOficial' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kwai",
  "endpoint": "/v1/kwai/user/posts",
  "data": {
    "id": "string",
    "query": "KwaiBrasilOficial",
    "status": "ok",
    "source": "kwai"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kwai Post

Kwai post. Availability depends on the configured provider route.

Parameters

url

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kwai/post
curl -X GET 'https://socialquery.dev/v1/kwai/post' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kwai",
  "endpoint": "/v1/kwai/post",
  "data": {
    "id": "string",
    "query": "https://www.kwai.com/@KwaiBrasilOficial/photo/5193363430624671876",
    "status": "ok",
    "source": "kwai"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Trends explore. Availability depends on the configured provider route.

Parameters

keywordsrequired

keywords parameter for this endpoint.

location

location parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

category

category parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_trends/explore
curl -X GET 'https://socialquery.dev/v1/google_trends/explore?keywords=uv+index' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_trends",
  "endpoint": "/v1/google_trends/explore",
  "data": {
    "id": "string",
    "query": "uv index",
    "status": "ok",
    "source": "google_trends"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Trends rising. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

location

location parameter for this endpoint.

timeframe

timeframe parameter for this endpoint.

category

category parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_trends/rising
curl -X GET 'https://socialquery.dev/v1/google_trends/rising?keyword=uv+index' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_trends",
  "endpoint": "/v1/google_trends/rising",
  "data": {
    "id": "string",
    "query": "uv index",
    "status": "ok",
    "source": "google_trends"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google Trends trending. Availability depends on the configured provider route.

Parameters

locationrequired

location parameter for this endpoint.

hours

hours parameter for this endpoint.

category

category parameter for this endpoint.

status

status parameter for this endpoint.

sort

sort parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_trends/trending
curl -X GET 'https://socialquery.dev/v1/google_trends/trending?location=DE' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_trends",
  "endpoint": "/v1/google_trends/trending",
  "data": {
    "id": "string",
    "query": "DE",
    "status": "ok",
    "source": "google_trends"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Trustpilot business search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

depth

depth parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/trustpilot/business-search
curl -X GET 'https://socialquery.dev/v1/trustpilot/business-search?query=nike' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "trustpilot",
  "endpoint": "/v1/trustpilot/business-search",
  "data": {
    "id": "string",
    "query": "nike",
    "status": "ok",
    "source": "trustpilot"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Trustpilot Reviews

Trustpilot reviews. Availability depends on the configured provider route.

Parameters

domainrequired

domain parameter for this endpoint.

depth

depth parameter for this endpoint.

sort

sort parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/trustpilot/reviews
curl -X GET 'https://socialquery.dev/v1/trustpilot/reviews?domain=www.nike.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "trustpilot",
  "endpoint": "/v1/trustpilot/reviews",
  "data": {
    "id": "string",
    "query": "www.nike.com",
    "status": "ok",
    "source": "trustpilot"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Trustpilot Reviews History

Trustpilot reviews history. Availability depends on the configured provider route.

Parameters

domainrequired

domain JSON body field for this endpoint.

depthrequired

depth JSON body field for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

POST/v1/trustpilot/reviews/history
curl -X POST 'https://socialquery.dev/v1/trustpilot/reviews/history' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
200401
Response example
{
  "success": true,
  "platform": "trustpilot",
  "endpoint": "/v1/trustpilot/reviews/history",
  "data": {
    "id": "string",
    "query": "",
    "status": "ok",
    "source": "trustpilot"
  },
  "credits_used": 6,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Wayfair search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

page

page parameter for this endpoint.

items_per_page

items_per_page parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

color

color parameter for this endpoint.

in_stock

in_stock parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/wayfair/search
curl -X GET 'https://socialquery.dev/v1/wayfair/search?query=office+chair' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "wayfair",
  "endpoint": "/v1/wayfair/search",
  "data": {
    "id": "string",
    "query": "office chair",
    "status": "ok",
    "source": "wayfair"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Wayfair Product

Wayfair product. Availability depends on the configured provider route.

Parameters

skurequired

sku parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/wayfair/product
curl -X GET 'https://socialquery.dev/v1/wayfair/product?sku=W003564166' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "wayfair",
  "endpoint": "/v1/wayfair/product",
  "data": {
    "id": "string",
    "query": "W003564166",
    "status": "ok",
    "source": "wayfair"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Wayfair Reviews

Wayfair reviews. Availability depends on the configured provider route.

Parameters

skurequired

sku parameter for this endpoint.

country

country parameter for this endpoint.

page

page parameter for this endpoint.

sort_order

sort_order parameter for this endpoint.

star

star parameter for this endpoint.

label

label parameter for this endpoint.

reports

reports parameter for this endpoint.

judgments

judgments parameter for this endpoint.

dry_run

dry_run parameter for this endpoint.

label_evidence

label_evidence parameter for this endpoint.

fit

fit parameter for this endpoint.

goal

goal parameter for this endpoint.

fit_tokens

fit_tokens parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/wayfair/reviews
curl -X GET 'https://socialquery.dev/v1/wayfair/reviews?sku=W003564166' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "wayfair",
  "endpoint": "/v1/wayfair/reviews",
  "data": {
    "id": "string",
    "query": "W003564166",
    "status": "ok",
    "source": "wayfair"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Snapchat Profile

Snapchat profile. Availability depends on the configured provider route.

Parameters

handlerequired

handle parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/snapchat/profile
curl -X GET 'https://socialquery.dev/v1/snapchat/profile?handle=djkhaled305' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "snapchat",
  "endpoint": "/v1/snapchat/profile",
  "data": {
    "id": "string",
    "query": "djkhaled305",
    "status": "ok",
    "source": "snapchat"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Snapchat Spotlight Comments

Snapchat spotlight comments. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

cursor

cursor parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/snapchat/spotlight/comments
curl -X GET 'https://socialquery.dev/v1/snapchat/spotlight/comments?url=https%3A%2F%2Fwww.snapchat.com%2F%40lilah4823%2Fspotlight%2FW7_EDlXWTBiXAEEniNoMPwAAYY2pvZnd0ZXVmAZ8fgG8pAZ8ff-_IAAAAAQ' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "snapchat",
  "endpoint": "/v1/snapchat/spotlight/comments",
  "data": {
    "id": "string",
    "query": "https://www.snapchat.com/@lilah4823/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYY2pvZnd0ZXVmAZ8fgG8pAZ8ff-_IAAAAAQ",
    "status": "ok",
    "source": "snapchat"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Ebay search. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

country

country parameter for this endpoint.

page

page parameter for this endpoint.

sort_by

sort_by parameter for this endpoint.

condition

condition parameter for this endpoint.

buying_format

buying_format parameter for this endpoint.

show_only

show_only parameter for this endpoint.

min_price

min_price parameter for this endpoint.

max_price

max_price parameter for this endpoint.

aspects

aspects parameter for this endpoint.

cursor

cursor parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/ebay/search
curl -X GET 'https://socialquery.dev/v1/ebay/search?query=airpods+pro' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "ebay",
  "endpoint": "/v1/ebay/search",
  "data": {
    "id": "string",
    "query": "airpods pro",
    "status": "ok",
    "source": "ebay"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

eBay Product

Ebay product. Availability depends on the configured provider route.

Parameters

product_idrequired

product_id parameter for this endpoint.

country

country parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/ebay/product
curl -X GET 'https://socialquery.dev/v1/ebay/product?product_id=327256602116' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "ebay",
  "endpoint": "/v1/ebay/product",
  "data": {
    "id": "string",
    "query": "327256602116",
    "status": "ok",
    "source": "ebay"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Kick Clip

Kick clip. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/kick/clip
curl -X GET 'https://socialquery.dev/v1/kick/clip?url=https%3A%2F%2Fkick.com%2Fxqc%2Fclips%2Fclip_abc123' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "kick",
  "endpoint": "/v1/kick/clip",
  "data": {
    "id": "string",
    "query": "https://kick.com/xqc/clips/clip_abc123",
    "status": "ok",
    "source": "kick"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Perplexity Research

Perplexity research. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/perplexity/research
curl -X GET 'https://socialquery.dev/v1/perplexity/research?query=What+is+the+capital+of+France%3F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "perplexity",
  "endpoint": "/v1/perplexity/research",
  "data": {
    "id": "string",
    "query": "What is the capital of France?",
    "status": "ok",
    "source": "perplexity"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Google News search. Availability depends on the configured provider route.

Parameters

keywordrequired

keyword parameter for this endpoint.

depth

depth parameter for this endpoint.

location_code

location_code parameter for this endpoint.

location_name

location_name parameter for this endpoint.

location_coordinate

location_coordinate parameter for this endpoint.

language_code

language_code parameter for this endpoint.

time_range

time_range parameter for this endpoint.

publisher

publisher parameter for this endpoint.

from

from parameter for this endpoint.

to

to parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/google_news/search
curl -X GET 'https://socialquery.dev/v1/google_news/search?keyword=openai' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "google_news",
  "endpoint": "/v1/google_news/search",
  "data": {
    "id": "string",
    "query": "openai",
    "status": "ok",
    "source": "google_news"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Linktree Page

Linktree page. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linktree/page
curl -X GET 'https://socialquery.dev/v1/linktree/page?url=https%3A%2F%2Flinktr.ee%2Fcharlidamelio' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linktree",
  "endpoint": "/v1/linktree/page",
  "data": {
    "id": "string",
    "query": "https://linktr.ee/charlidamelio",
    "status": "ok",
    "source": "linktree"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Linkbio Page

Linkbio page. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkbio/page
curl -X GET 'https://socialquery.dev/v1/linkbio/page?url=https%3A%2F%2Flnk.bio%2Fexample' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkbio",
  "endpoint": "/v1/linkbio/page",
  "data": {
    "id": "string",
    "query": "https://lnk.bio/example",
    "status": "ok",
    "source": "linkbio"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Linkme Page

Linkme page. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/linkme/page
curl -X GET 'https://socialquery.dev/v1/linkme/page?url=https%3A%2F%2Flink.me%2Fexample' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "linkme",
  "endpoint": "/v1/linkme/page",
  "data": {
    "id": "string",
    "query": "https://link.me/example",
    "status": "ok",
    "source": "linkme"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Komi Page

Komi page. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/komi/page
curl -X GET 'https://socialquery.dev/v1/komi/page?url=https%3A%2F%2Fkimkardashian.komi.io%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "komi",
  "endpoint": "/v1/komi/page",
  "data": {
    "id": "string",
    "query": "https://kimkardashian.komi.io/",
    "status": "ok",
    "source": "komi"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Pillar Page

Pillar page. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/pillar/page
curl -X GET 'https://socialquery.dev/v1/pillar/page?url=https%3A%2F%2Fpillar.io%2Fexample' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "pillar",
  "endpoint": "/v1/pillar/page",
  "data": {
    "id": "string",
    "query": "https://pillar.io/example",
    "status": "ok",
    "source": "pillar"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Polymarket Research

Polymarket research. Availability depends on the configured provider route.

Parameters

queryrequired

query parameter for this endpoint.

limit

limit parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/polymarket/research
curl -X GET 'https://socialquery.dev/v1/polymarket/research?query=trump+2028+election' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "polymarket",
  "endpoint": "/v1/polymarket/research",
  "data": {
    "id": "string",
    "query": "trump 2028 election",
    "status": "ok",
    "source": "polymarket"
  },
  "credits_used": 5,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

On Page Page

On Page page. Availability depends on the configured provider route.

Parameters

urlrequired

url parameter for this endpoint.

enable_javascript

enable_javascript parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/on_page/page
curl -X GET 'https://socialquery.dev/v1/on_page/page?url=https%3A%2F%2Fwww.socialcrawl.dev%2F' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "on_page",
  "endpoint": "/v1/on_page/page",
  "data": {
    "id": "string",
    "query": "https://www.socialcrawl.dev/",
    "status": "ok",
    "source": "on_page"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result

Product Hunt Launches

Producthunt launches. Availability depends on the configured provider route.

Parameters

topic

topic parameter for this endpoint.

query

query parameter for this endpoint.

since

since parameter for this endpoint.

until

until parameter for this endpoint.

Responses

200 Successful responseapplication/json
401

Unauthorized - missing or invalid API key

GET/v1/producthunt/launches
curl -X GET 'https://socialquery.dev/v1/producthunt/launches' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"
200401
Response example
{
  "success": true,
  "platform": "producthunt",
  "endpoint": "/v1/producthunt/launches",
  "data": {
    "id": "string",
    "query": "artificial-intelligence",
    "status": "ok",
    "source": "producthunt"
  },
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "string",
  "cached": false
}
Illustrative response · not a live result