Which endpoint should I use?
Onekey has many endpoints per platform. This page answers the questions that come up most. When a question is about price, the endpoint page always shows the exact credits; see also the price list.
Start here#
| You have | You want | Use |
|---|---|---|
| A public URL (a post, video, product, repo, profile) | The data behind it | URL lookup: GET /v1/lookup?url=. It picks the endpoint for you and charges that endpoint's price. |
| A handle or id and a platform | One record | The platform's profile, post or item endpoint. Open the catalog. |
| A topic, brand or phrase | Posts across platforms | Universal search for a ranked, planned answer, or multi-platform search when you choose the platforms. |
| A handle | The same creator on several platforms | Creator card. |
| A list of ids or URLs | Many records in one request | Batch. |
| Something that should be checked on a schedule | A webhook when it changes | A monitor. |
| A question about a brand, creator or topic | A packaged answer | A report. |
A profile, or a profile with its posts?#
Many platforms have a plain profile endpoint and a fuller variant. On Instagram, TikTok and X the plain one returns the account; the profile_full variant returns the account with extra detail in one call: instagram.profile and instagram.profile_full, tiktok.profile and tiktok.profile_full, x.profile and x.profile_full. Pick the plain one when you only need the numbers, and the full one when a second call would otherwise follow. The price of each is on its page.
One post or a list of posts?#
- A single post by id or URL:
instagram.post,tiktok.video,x.tweet,youtube.video,reddit.post. - A creator's recent posts:
instagram.posts,tiktok.user_videos,x.user_tweets,youtube.channel_videos,reddit.user_posts. These are list endpoints and page with a cursor; see Pagination. - Posts that match a search: the platform's search endpoint, for example
tiktok.search_videos,x.search,reddit.search_posts,youtube.search.
Search one platform, a few, or everywhere?#
| If | Use |
|---|---|
| You know the platform | That platform's search endpoint. Cheapest, and every filter it supports is a parameter. |
| You want a few named platforms in one answer | GET /v1/search/multi with platforms=. Rows arrive in one shape; add fuse=rrf to merge the rankings. |
| You do not know where the conversation is | GET /v1/search/universal. It plans the platforms from your query, fans out, and rank-fuses the results. dry_run=true shows the plan and the worst-case price first. |
Comments#
- Comments under a post:
tiktok.comments,instagram.comments,youtube.comments,reddit.post_comments. - Replies to one comment:
tiktok.comment_replies,instagram.post_comment_replies,youtube.comment_replies. - Comments that match a keyword across a platform:
reddit.search_comments.
Transcripts#
Video and audio transcripts exist as their own endpoints: youtube.transcript, tiktok.post_transcript, reddit.post_transcript, x.tweet_transcript. They are priced separately from the post.
Ads#
Ad library endpoints are per network: facebook.ad_library (Meta), tiktok.adlibrary_search, google.company_ads, linkedin.ads_search.
Apps and stores#
Apple apps: itunes.search_apps and itunes.lookup_app. Google Play: googleplay.search and googleplay.app. Charts: app_store.app_chart.
Products and reviews#
- Amazon:
amazon.search,amazon.product,amazon.reviews,amazon.bestsellers. - Other retailers each have their own platform page; use the catalog and its category filter.
- Reviews of businesses:
trustpilot.reviews,yelp.reviews,tripadvisor.reviews.
Jobs#
Onekey has job boards as platforms (for example remotive.jobs, remoteok.jobs, himalayas.jobs, themuse.jobs, greenhouse.jobs, lever.postings, ashby.jobs) and company job pages. Universal search can search several at once.
Fresh numbers at scale#
For one value, call the single endpoint. For hundreds of ids, use batch: one request, per-row results, and only the rows that returned data are billed. A repeat inside the cache window is free either way, see Caching.
Still unsure?#
Search the catalog or press the search key on any docs page, read the category that fits, or see the common jobs page for end-to-end recipes. If the answer you need has no endpoint, tell us.