API Documentation

ZenAPI provides stable JSON endpoints for social, finance, and media data. Use service-specific routes for new integrations. The legacy universal/v1/scraperoute remains available for compatibility.

Authentication

Generate an API key in your dashboard and include it in the `Authorization` header for every request.

Authorization: Token YOUR_API_KEY

Request Body

Public endpoints use a consistent body shape. `target` is for direct lookups, `query` is for search, `params` carries endpoint-specific options, and `nocache` bypasses Redis cache when needed.

Name	Type	Description
`target`	string	Username, ticker symbol, IMDb id, URL, or direct lookup value.
`query`	string	Search query. Used as target when target is omitted.
`params`	object	Endpoint-specific options such as date ranges or filters.
`nocache`	boolean	If true, bypasses cached responses.

Credit Costs

Every successful request uses the service-level credit cost shown below. The same cost applies to all endpoints within a service.

Service	Credits per request
LinkedIn	25
Google Search	10
Reddit	5
YouTube	4
Instagram	3
Yahoo Finance	1
X	1
Google Maps	1
IMDb	1
TikTok	1

Cache hits are charged as successful responses. Validation, authentication, and rate-limit failures do not consume credits. Provider and server 5xx responses refund reserved credits.

POST

/v1/instagram/profiles/get

Instagram Profile

Retrieve a normalized Instagram profile by username.

{"target":"cristiano"}

Instagram Endpoints

POST/v1/instagram/profiles/get

Profile by username

POST/v1/instagram/users/search

Search users

POST/v1/instagram/media/list

Media by user id

POST/v1/instagram/media/get

Media info by post URL

POST/v1/instagram/media/download

Media download data

POST/v1/instagram/reels/list

Reels by user id

POST/v1/instagram/hashtags/media

Hashtag media

POST

/v1/tiktok/profiles/get

TikTok Profile

Retrieve TikTok profile data by username. Requires the TikTok provider host to be configured in the engine runtime.

{"target":"tiktok"}

TikTok Endpoints

POST/v1/tiktok/profiles/get

Profile by username

POST/v1/tiktok/users/posts

User posts by secUid

POST/v1/tiktok/search/videos

Search videos

POST/v1/tiktok/search/accounts

Search accounts

POST/v1/tiktok/videos/get

Video details

POST/v1/tiktok/videos/comments

Video comments

POST/v1/tiktok/videos/trending

/v1/yahoo-finance/quotes/get

Yahoo Finance Quote

Retrieve quote summary data by ticker symbol.

{"target":"AAPL"}

Yahoo Finance Endpoints

POST/v1/yahoo-finance/search

Search instruments

POST/v1/yahoo-finance/quotes/get

Quote summary

POST/v1/yahoo-finance/quotes/profile

Company profile

POST/v1/yahoo-finance/quotes/statistics

Quote statistics

POST/v1/yahoo-finance/quotes/history

Historical data

POST/v1/yahoo-finance/stocks/most-active

Most active stocks

POST/v1/yahoo-finance/stocks/top-gainers

Top gainers

POST/v1/yahoo-finance/stocks/top-losers

Top losers

POST

/v1/imdb/titles/get

IMDb Title

Retrieve title details by IMDb title id.

{"target":"tt0111161"}

IMDb Endpoints

POST/v1/imdb/search

Search titles

POST/v1/imdb/titles/get

Title details

POST/v1/imdb/titles/rating

Title rating

POST/v1/imdb/titles/cast

Title cast

POST/v1/imdb/titles/similar

Similar titles

POST/v1/imdb/names/get

Person details

POST/v1/imdb/lists/top250-movies

Top 250 movies

POST/v1/imdb/lists/most-popular-movies

/v1/google-maps/search

Google Maps Places Search

Search Google Maps places by query. Optional params include country, lang, limit, lat, lng, offset, and zoom.

{"query":"restaurant","params":{"country":"us","lang":"en","limit":"20"}}

Google Maps Endpoints

POST/v1/google-maps/search

Places search

POST/v1/google-maps/nearby

Nearby places

POST/v1/google-maps/places/get

Place details

POST/v1/google-maps/geocoding/get

Geocoding

POST/v1/google-maps/reviews/list

Place reviews

POST/v1/google-maps/photos/list

Place photos

POST/v1/google-maps/locations/what-is-here

Reverse location lookup

POST

/v1/google-search/images/search

Google Image Search

Search Google Images by query. Optional params include gl, lr, num, and page.

{"query":"World Cup","params":{"gl":"us","lr":"lang_en","num":"10","page":"1"}}

Google Search Endpoints

POST/v1/google-search/images/search

Image search

POST

/v1/youtube/videos/get

YouTube Video

Retrieve YouTube video details by video id. Optional params can be passed through the standard params object.

{"target":"PuQFESk0BrA"}

YouTube Endpoints

POST/v1/youtube/videos/get

Video details

POST/v1/youtube/videos/data

Video data

POST/v1/youtube/videos/comments

Video comments

POST/v1/youtube/videos/subtitles

Video subtitles

POST/v1/youtube/videos/recommendations

Video recommendations

POST/v1/youtube/channels/id

Channel id by name

POST/v1/youtube/channels/get

Channel details

POST/v1/youtube/channels/videos

Channel videos

POST/v1/youtube/channels/shorts

Channel shorts

POST/v1/youtube/channels/search

Search inside channel

POST/v1/youtube/search

Search videos

POST/v1/youtube/trending

/v1/linkedin/companies/get

LinkedIn Company

Retrieve LinkedIn company details by company username. LinkedIn endpoints also support profile, job, post, and location research use cases.

{"target":"google"}

LinkedIn Endpoints

POST/v1/linkedin/profiles/get

Profile by username

POST/v1/linkedin/profiles/get-by-url

Profile by URL

POST/v1/linkedin/profiles/search

People search

POST/v1/linkedin/profiles/posts

Profile posts

POST/v1/linkedin/profiles/comments

Profile comments

POST/v1/linkedin/profiles/connection-count

Connection count

POST/v1/linkedin/profiles/recent-activity

Recent activity

POST/v1/linkedin/profiles/similar

Similar profiles

POST/v1/linkedin/profiles/position-skills

Position skills

POST/v1/linkedin/profiles/top-positions

Top positions

POST/v1/linkedin/profiles/posted-jobs

Posted jobs by profile

POST/v1/linkedin/profiles/articles

Profile articles

POST/v1/linkedin/companies/get

Company details

POST/v1/linkedin/companies/get-by-id

Company by id

POST/v1/linkedin/companies/get-by-domain

Company by domain

POST/v1/linkedin/companies/insights

Company insights

POST/v1/linkedin/companies/jobs-count

Company jobs count

POST/v1/linkedin/companies/posts

Company posts

POST/v1/linkedin/jobs/search

Job search

POST/v1/linkedin/jobs/get

Job details

POST/v1/linkedin/posts/get

Post details

POST/v1/linkedin/locations/search

Location search

POST

/v1/reddit/search

Reddit Search

Search Reddit content by keyword. Optional params include subreddit, filter, timeFilter, and sortType.

{"query":"investing","params":{"subreddit":"wallstreetbets","filter":"posts"}}

Reddit Endpoints

POST/v1/reddit/search

Search Reddit

POST/v1/reddit/subreddits/posts

Subreddit posts

POST/v1/reddit/posts/get

Post details

POST/v1/reddit/subreddits/popular

Popular subreddits

POST/v1/reddit/subreddits/new

New subreddits

POST/v1/reddit/subreddits/get

Subreddit info

POST/v1/reddit/subreddits/comments

Subreddit comments

POST/v1/reddit/users/stats

User stats

POST/v1/reddit/users/data

User data

POST

/v1/x/profiles/get

X Profile

Retrieve X profile data by screen name. X endpoints also support timeline, tweet, search, trends, and community research use cases.

{"target":"elonmusk"}

X Endpoints

POST/v1/x/profiles/get

Profile by screen name

POST/v1/x/profiles/about

Profile about data

POST/v1/x/users/timeline

User timeline

POST/v1/x/users/following

Following

POST/v1/x/users/followers

Followers

POST/v1/x/users/media

User media

POST/v1/x/tweets/get

Tweet details

POST/v1/x/tweets/thread

Tweet thread

POST/v1/x/tweets/latest-replies

Latest replies

POST/v1/x/tweets/retweets

Retweets

POST/v1/x/search

Search posts

POST/v1/x/trends

Trends

POST/v1/x/top-posts

Error Responses

401Unauthorized

Invalid or missing API key.

400Bad Request

Missing or invalid request parameters.

429Rate Limit Exceeded

Rate limit or plan limit reached.

503Provider Temporarily Unavailable

The requested data source is temporarily unavailable.