Docs
View as Markdown

Alternatives and equivalents

If you know a capability under another name, or from an API that shapes its paths differently, this page says which Onekey endpoint or feature covers it. The data is the same; the names differ.

How Onekey names things#

  • Every data endpoint is GET /v1/{platform}/{endpoint}: one path segment after the platform, with underscores, for example /v1/linkedin/company_affiliated_pages. APIs that nest the path (/linkedin/company/affiliated-pages) correspond to the same name with the slashes and hyphens turned into underscores. Nested paths also work (see below), so a client written for the nested shape can call us without a rewrite.
  • The ids on this site (linkedin.company_affiliated_pages) are the same names with a dot after the platform.
  • The platform x is the one other services call twitter.
  • Where one call elsewhere bundles several, here it is a batch of single calls, or one of the composite routes below.

Nested paths#

A read-only GET /v1/{platform}/{a}/{b} is served by the canonical GET /v1/{platform}/{a_b} endpoint: /v1/tiktok/profile/videos answers with the same data, price, cache and envelope as /v1/tiktok/profile_videos, with the same key and the same errors. Segments after the platform are joined with _ and hyphens become _; a built-in table covers the path-style names below that are not a plain join (/amazon/product-search is amazon.search). When a name below lists several endpoints, the first one is the alias target.

The answer says what ran: an alias object (requested_path, canonical_id, canonical_path) and an X-Canonical-Endpoint header. Idempotency keys and cached copies are shared with the canonical path, so switching between the two shapes never double-bills. Aliases are not separate operations in the OpenAPI document; code against the canonical paths. An unknown path answers the normal 404 NOT_FOUND. Only GET is aliased.

By capability#

You are looking forUse here
A profile, a post, a comment list, a transcript on one platformThe platform's endpoint, GET /v1/{platform}/{endpoint}. Find it in the catalog or with Which endpoint should I use?.
Paste any URL, get the right recordURL lookup: GET /v1/lookup?url=, billed at the resolved endpoint's price.
Search one topic on several platforms and mergeMulti-platform search: GET /v1/search/multi, with fuse=rrf for rank fusion.
Search everywhere from one questionUniversal search: GET /v1/search/universal, with a free dry_run=true plan.
The same creator on every platformCreator card: GET /v1/creator/card.
Batches of up to a hundred lookups, per-row billing, refunds for missesBatch: POST /v1/batch, with Accept: text/event-stream for streaming.
Comparable engagement numbers across platformsComputed block: engagement_rate, estimated_reach, language, free.
Sentiment, intent and similar labels on comments, posts, reviewsLabels, relevance and themes. Built, opt-in, not enabled yet; see AI pricing.
Brand mentions, creator vetting, demand signalsReports: /v1/reports/brand-mentions, /creator-vet, /demand-signals.
Scheduled watches with signed webhooks, change deltas and alert rulesMonitors: /v1/monitors.
Cursor pagination with one conventionPagination: pagination.next_cursor, has_more, page_size.
Safe retries without double billingIdempotency: the Idempotency-Key header, 24 hours.
Free cache hits and a forced fresh fetchCaching: cache hits cost 0; Cache-Control: no-cache forces a live fetch at the normal price.
Spend caps per keyPer-key credit limits: PUT /v1/keys/{id}/budget, error KEY_BUDGET_EXCEEDED.
Machine-readable errors with a link to the fixErrors: error.type and error.doc_url on every failure; GET /v1/errors lists them.
A public status endpointStatus: GET /v1/status, no key, no credits.
A balance checkGET /v1/account, free. See Credits.
Per-platform text files and a Markdown twin of every page/llms.txt, /llms-full.txt, /llms/{platform} and .md on every docs page. See AI agents.
An OpenAPI documentGET /v1/openapi.json (also /openapi.json).
A hosted MCP server and an agent skillMCP server; the skill is described there.
Integration guidesn8n, LangChain, Vercel AI SDK, Claude Code.

By path-style name#

347 names below resolve to an endpoint or route here. Press the search key to find one.

Aliexpress#

Path-style nameUse here
/aliexpress/product/similaraliexpress.product_similar
/aliexpress/product/shippingaliexpress.product_shipping
/aliexpress/search/hotaliexpress.search_hot
/aliexpress/search/promoaliexpress.search_promo

Amazon#

Path-style nameUse here
/amazon/product-searchamazon.search
/amazon/best-sellersamazon.bestsellers

App Store#

Path-style nameUse here
/app_store/app-searchitunes.search_apps, app_store.app_listings_search
/app_store/search-suggestionsapp_store.search_suggestions
/app_store/app-infoitunes.lookup_app
/app_store/app-listapp_store.app_list
/app_store/app-listings-searchapp_store.app_listings_search

Apple Music#

Path-style nameUse here
/apple_music/searchitunes.search_music, itunes.search_albums, itunes.search_artists
/apple_music/artistitunes.lookup_artist

Bluesky#

Path-style nameUse here
/bluesky/user/postsbluesky.posts
/bluesky/postbluesky.post_thread, bluesky.posts_by_uri

Discovery#

Path-style nameUse here
/utility/endpointsGET /v1/platforms
/utility/endpointGET /v1/openapi.json
/utility/capabilitiesGET /v1/platforms
/utility/quickstartQuickstart
/utility/llms/llms.txt and /llms-full.txt

Douyin#

Path-style nameUse here
/douyin/profile/postsdouyin.profile_posts
/douyin/post/commentsdouyin.post_comments
/douyin/comment/repliesdouyin.comment_replies
/douyin/search/usersdouyin.search_users

eBay#

Path-style nameUse here
/ebay/productebay.item

Etsy#

Path-style nameUse here
/etsy/productetsy.listing
/etsy/shop/productsetsy.listings
/etsy/product/similaretsy.product_similar
/etsy/search/suggestionsetsy.search_suggestions

Facebook#

Path-style nameUse here
/facebook/profilefacebook.page
/facebook/profile/postsfacebook.page_posts
/facebook/post/commentsfacebook.post_comments
/facebook/group/postsfacebook.group_posts
/facebook/post/transcriptfacebook.post_transcript
/facebook/profile/photosfacebook.page_photos
/facebook/profile/reelsfacebook.profile_reels_full
/facebook/adlibrary/adfacebook.adlibrary_ad
/facebook/adlibrary/company/adsfacebook.adlibrary_company_ads
/facebook/adlibrary/search/adsfacebook.ad_library
/facebook/adlibrary/search/companiesfacebook.adlibrary_search_companies
/facebook/profile/eventsfacebook.page_events
/facebook/post/comment/repliesfacebook.post_comment_replies
/facebook/marketplace/location/searchfacebook.marketplace_location_search
/facebook/marketplace/searchfacebook.marketplace_search
/facebook/marketplace/itemfacebook.marketplace_item
/facebook/events/searchfacebook.events_search
/facebook/event/detailsfacebook.event_details
/facebook/adlibrary/ad/transcriptfacebook.adlibrary_ad_transcript
/facebook/profile/fullfacebook.profile_full
/facebook/profile/reels/fullfacebook.profile_reels_full
/facebook/search/postsfacebook.search_posts
/facebook/search/pagesfacebook.search_pages
/facebook/search/peoplefacebook.search_people
/facebook/search/videosfacebook.search_videos
/facebook/search/groupsfacebook.search_groups

G2#

Path-style nameUse here
/g2/seller/productsg2.seller_products
/g2/product-indexg2.product_index

GitHub#

Path-style nameUse here
/github/profile/reposgithub.repos
/github/repo/readmegithub.readme
/github/repo/releasesgithub.releases
/github/repo/issuesgithub.issues
/github/issue/commentsgithub.issue_comments
/github/repo/top-issuesgithub.top_issues
/github/repo/dossiergithub.repo_dossier
/github/user/profile-velocitygithub.user_profile_velocity

Google#

Path-style nameUse here
/google/adlibrary/advertisers/searchgoogle.adlibrary_advertisers_search
/google/company/adsgoogle.company_ads
/google/business/infogoogle.business_info
/google/business/extended-reviewsgoogle.business_extended_reviews

Google News#

Path-style nameUse here
/google_news/searchgoogle.news, gdelt.articles

Google Play#

Path-style nameUse here
/google_play/app-searchgoogleplay.search, google_play.app_listings_search
/google_play/app-infogoogleplay.app
/google_play/app-listings-searchgoogle_play.app_listings_search

Google Shopping#

Path-style nameUse here
/google_shopping/product-searchgoogle.shopping
/google_shopping/price-historygoogle_shopping.price_history
Path-style nameUse here
/google_trends/exploregoogle.trends, google_trends.trending

Gumtree#

Path-style nameUse here
/gumtree/product/similargumtree.product_similar
/gumtree/seller/listingsgumtree.seller_listings
/gumtree/search/suggestionsgumtree.search_suggestions
/gumtree/locations/nearestgumtree.locations_nearest

Hacker News#

Path-style nameUse here
/hackernews/storyhackernews.item
/hackernews/story/commentshackernews.story_comments
/hackernews/profilehackernews.user

Hm#

Path-style nameUse here
/hm/search/suggestionshm.search_suggestions
/hm/product/suppliershm.product_suppliers

Instagram#

Path-style nameUse here
/instagram/profile/aboutinstagram.profile_about
/instagram/profile/postsinstagram.posts
/instagram/post/commentsinstagram.comments
/instagram/basic-profileinstagram.basic_profile
/instagram/profile/reelsinstagram.reels
/instagram/highlight/detailinstagram.highlight_detail
/instagram/search/reelsinstagram.search_reels
/instagram/media/transcriptinstagram.media_transcript
/instagram/media/screen-textinstagram.media_screen_text
/instagram/user/embedinstagram.user_embed
/instagram/audio/reelsinstagram.audio_reels
/instagram/search/hashtaginstagram.search_hashtags, instagram.hashtag
/instagram/search/profilesinstagram.search_users
/instagram/reels/trendinginstagram.reels_trending
/instagram/post/likersinstagram.post_likers
/instagram/post/statsinstagram.post_stats
/instagram/location/postsinstagram.location_posts
/instagram/search/locationinstagram.search_location
/instagram/search/popularinstagram.search_popular
/instagram/post/comment/repliesinstagram.post_comment_replies
/instagram/username-suggestionsinstagram.username_suggestions
/instagram/search/musicinstagram.search_music
/instagram/story/downloadinstagram.story_download
/instagram/music/trendinginstagram.music_trending
/instagram/profile/fullinstagram.profile_full
/instagram/profile/reels/fullinstagram.profile_reels_full
/instagram/profile/posts/fullinstagram.profile_posts_full

Kick#

Path-style nameUse here
/kick/clipkick.clips

Klarna#

Path-style nameUse here
/klarna/product/offersklarna.product_offers
/klarna/search/suggestionsklarna.search_suggestions
/klarna/reviews/proklarna.reviews_pro
/klarna/reviews/overviewklarna.reviews_overview
/klarna/product/price-historyklarna.product_price_history
/klarna/product/compareklarna.product_compare
/klarna/categories/childrenklarna.categories_children
/klarna/category/filtersklarna.category_filters
/klarna/category/keywordsklarna.category_keywords
/klarna/category/guideklarna.category_guide
/klarna/store/productsklarna.store_products
/klarna/store/filtersklarna.store_filters

Kwai#

Path-style nameUse here
/kwai/user/postskwai.user_posts

LinkedIn#

Path-style nameUse here
/linkedin/company/by-domainlinkedin.company_by_domain
/linkedin/profile/similarlinkedin.profile_similar
/linkedin/search/companieslinkedin.search_companies
/linkedin/profile/posted-jobslinkedin.profile_posted_jobs
/linkedin/job/hiring-teamlinkedin.job_hiring_team
/linkedin/profile/articleslinkedin.profile_articles
/linkedin/article/commentslinkedin.article_comments
/linkedin/article/reactionslinkedin.article_reactions
/linkedin/search/hashtaglinkedin.search_hashtag
/linkedin/profile/activitylinkedin.profile_activity
/linkedin/company/also-viewedlinkedin.company_also_viewed
/linkedin/company/employees-countlinkedin.company_employees_count
/linkedin/profile/interests/schoolslinkedin.profile_interests_schools
/linkedin/profile/interests/newsletterslinkedin.profile_interests_newsletters
/linkedin/profile/interests/top-voiceslinkedin.profile_interests_top_voices
/linkedin/profile/position-skillslinkedin.profile_position_skills
/linkedin/profile/top-positionlinkedin.profile_top_position
/linkedin/search/people/by-urllinkedin.search_people_by_url
/linkedin/profile/alllinkedin.profile_all
/linkedin/profile/completelinkedin.profile_complete
/linkedin/profile/with-postslinkedin.profile_with_posts
/linkedin/post/with-commentslinkedin.post_with_comments
/linkedin/search/peoplelinkedin.search_people
/linkedin/company/peoplelinkedin.company_people
/linkedin/post/commentslinkedin.post_comments
/linkedin/profile/postslinkedin.profile_posts
/linkedin/profile/reactionslinkedin.profile_reactions
/linkedin/post/repostslinkedin.post_reposts
/linkedin/group/postslinkedin.group_posts
/linkedin/company/affiliated-pageslinkedin.company_affiliated_pages
/linkedin/post/comments/replieslinkedin.post_comment_replies
/linkedin/profile/experienceslinkedin.profile_experiences
/linkedin/profile/educationslinkedin.profile_educations
/linkedin/profile/skillslinkedin.profile_skills
/linkedin/profile/honorslinkedin.profile_honors
/linkedin/profile/certificationslinkedin.profile_certifications
/linkedin/profile/publicationslinkedin.profile_publications
/linkedin/profile/volunteerslinkedin.profile_volunteers
/linkedin/profile/recommendationslinkedin.profile_recommendations
/linkedin/profile/interests/companieslinkedin.profile_interests_companies
/linkedin/profile/interests/groupslinkedin.profile_interests_groups
/linkedin/profile/imageslinkedin.profile_images
/linkedin/profile/videoslinkedin.profile_videos
/linkedin/profile/commentslinkedin.profile_comments
/linkedin/post/reactionslinkedin.post_reactions
/linkedin/company/jobslinkedin.company_jobs
/linkedin/search/jobslinkedin.search_jobs
/linkedin/search/locationlinkedin.search_location
/linkedin/search/schoolslinkedin.search_schools
/linkedin/search/industrylinkedin.search_industry
/linkedin/profile/aboutlinkedin.profile_about
/linkedin/profile/contactlinkedin.profile_contact
/linkedin/profile/statslinkedin.profile_stats
/linkedin/company/job-countlinkedin.company_job_count
/linkedin/company/insightslinkedin.company_insights
/linkedin/company/postslinkedin.company_posts
/linkedin/ads/searchlinkedin.ads_search
/linkedin/profile/posts/archivelinkedin.profile_posts_archive
/linkedin/search/postslinkedin.search_posts
/linkedin/post/transcriptlinkedin.post_transcript
/linkedin/profile/fulllinkedin.profile_full

Markets#

Path-style nameUse here
/finance/quoteyahoo.quote
/finance/ticker-searchyahoo.search
/finance/historyyahoo.history

Monitors#

Path-style nameUse here
/monitorsPOST/GET /v1/monitors
/monitors/{id}GET/PATCH/DELETE /v1/monitors/{id}
/monitors/{id}/runsGET /v1/monitors/{id}/runs
Path-style nameUse here
/naver/blog/searchnaver.blog_search
/naver/news/searchnaver.news_search
/naver/encyc/searchnaver.encyc_search
/naver/cafearticle/searchnaver.cafearticle_search
/naver/kin/searchnaver.kin_search
/naver/local/searchnaver.local_search
/naver/image/searchnaver.image_search
/naver/webkr/searchnaver.webkr_search
/naver/search-trendnaver.search_trend
/naver/shopping-insight/categorynaver.shopping_insight_category
/naver/shopping-insight/keywordnaver.shopping_insight_keyword
/naver/briefnaver.news_search

News and web coverage#

Path-style nameUse here
/content_analysis/searchgdelt.articles
/content_analysis/summarycontent_analysis.summary, gdelt.volume_timeline, content_analysis.sentiment
/content_analysis/phrase-trendscontent_analysis.phrase_trends, gdelt.volume_timeline, gdelt.tone_timeline

Perplexity#

Path-style nameUse here
/perplexity/researchperplexity.search

Pinterest#

Path-style nameUse here
/pinterest/searchpinterest.search_pins
/pinterest/url-statspinterest.url_stats

Product Hunt#

Path-style nameUse here
/producthunt/launchesproducthunt.posts_today

Quora#

Path-style nameUse here
/quora/postquora.question, quora.answers
/quora/profilesquora.profile

Reddit#

Path-style nameUse here
/reddit/subredditreddit.subreddit_hot, reddit.subreddit_new, reddit.subreddit_top
/reddit/subreddit/detailsreddit.subreddit_about
/reddit/searchreddit.search_posts
/reddit/post/commentsreddit.post_comments
/reddit/subreddit/searchreddit.search_subreddit
/reddit/profilereddit.user_about
/reddit/profile/postsreddit.user_posts
/reddit/profile/commentsreddit.user_comments
/reddit/search/commentsreddit.search_comments
/reddit/subreddits/searchreddit.search_subreddits
/reddit/search/mediareddit.search_media
/reddit/post/transcriptreddit.post_transcript
/reddit/omni-searchreddit.search_posts, reddit.post_comments

Rumble#

Path-style nameUse here
/rumble/video/transcriptrumble.video_transcript
/rumble/video/commentsrumble.video_comments

Search across platforms#

Sephora#

Path-style nameUse here
/sephora/search/suggestionssephora.search_suggestions
/sephora/category/datasephora.category_data
/sephora/brand/productssephora.brand_products

Snapchat#

Path-style nameUse here
/snapchat/spotlight/commentssnapchat.spotlight_comments

Spotify#

Path-style nameUse here
/spotify/searchspotify.search_tracks, spotify.search_artists
/spotify/podcast/episodesspotify.podcast_episodes

Status and account#

Path-style nameUse here
/credits/balanceGET /v1/credits/balance
/credits/transactionsGET /v1/credits/transactions
/statusGET /v1/status

Target#

Path-style nameUse here
/target/categorytarget.categories, target.search

Telegram#

Path-style nameUse here
/telegram/profiletelegram.channel
/telegram/profile/poststelegram.posts

Threads#

Path-style nameUse here
/threads/user/poststhreads.user_posts
/threads/post/commentsthreads.replies
/threads/search/usersthreads.search_users

TikTok#

Path-style nameUse here
/tiktok/profile/videostiktok.user_videos
/tiktok/posttiktok.video
/tiktok/post/commentstiktok.comments
/tiktok/video/comment/repliestiktok.comment_replies
/tiktok/searchtiktok.search_videos, tiktok.search_top
/tiktok/search/hashtagtiktok.hashtag_videos
/tiktok/search/toptiktok.search_top
/tiktok/search/userstiktok.search_users
/tiktok/user/audiencetiktok.user_audience
/tiktok/user/followerstiktok.followers
/tiktok/user/followingtiktok.following
/tiktok/user/livetiktok.user_live
/tiktok/post/transcripttiktok.post_transcript
/tiktok/video/screen-texttiktok.video_screen_text
/tiktok/songtiktok.music
/tiktok/song/videostiktok.music_videos
/tiktok/hashtags/populartiktok.hashtags_popular
/tiktok/videos/populartiktok.videos_popular
/tiktok/profile/regiontiktok.profile_region
/tiktok/adlibrary/searchtiktok.adlibrary_search
/tiktok/adlibrary/adtiktok.adlibrary_ad
/tiktok/search/suggestionstiktok.search_suggestions
/tiktok/collection/videostiktok.collection_videos
/tiktok/profile/playliststiktok.user_playlists
/tiktok/playlist/videostiktok.playlist_videos
/tiktok/user/likedtiktok.user_liked
/tiktok/location/poststiktok.location_posts
/tiktok/effect/videostiktok.effect_videos
/tiktok/search/musictiktok.search_music
/tiktok/ads/toptiktok.ads_top
/tiktok/profile/fulltiktok.profile_full

Tiktokshop#

Path-style nameUse here
/tiktokshop/product/reviewstiktokshop.product_reviews
/tiktokshop/user/showcasetiktokshop.user_showcase

Tripadvisor#

Path-style nameUse here
/tripadvisor/placetripadvisor.location, tripadvisor.hotel, tripadvisor.restaurant, tripadvisor.attraction
/tripadvisor/restaurant/reviewstripadvisor.restaurant_reviews
/tripadvisor/attraction/reviewstripadvisor.attraction_reviews
/tripadvisor/experience-typestripadvisor.experience_types
/tripadvisor/cruise/reviewstripadvisor.cruise_reviews

Trustpilot#

Path-style nameUse here
/trustpilot/business-searchtrustpilot.business

Truthsocial#

Path-style nameUse here
/truthsocial/user/poststruthsocial.user_posts

Twitch#

Path-style nameUse here
/twitch/user/videostwitch.videos
/twitch/user/scheduletwitch.user_schedule

Us Congress Trades#

Path-style nameUse here
/us_congress_trades/trades/latestus_congress_trades.trades
/us_congress_trades/trades/recentus_congress_trades.trades
/us_congress_trades/politicianus_congress_trades.politician_trades
/us_congress_trades/politician/tradesus_congress_trades.politician_trades
/us_congress_trades/tickerus_congress_trades.ticker_trades
/us_congress_trades/ticker/tradesus_congress_trades.ticker_trades

Web pages#

X (Twitter)#

Path-style nameUse here
/twitter/user/tweetsx.user_tweets
/twitter/community/tweetsx.community_tweets
/twitter/tweet/transcriptx.tweet_transcript
/twitter/ai-searchx.ai_search
/twitter/search/tweetsx.search
/twitter/tweet/repliesx.thread
/twitter/user/mediax.user_media
/twitter/user/followersx.followers
/twitter/user/followingx.following
/twitter/tweet/retweetersx.retweeters
/twitter/search/usersx.search_users
/twitter/profile/fullx.profile_full

Xiaohongshu#

Path-style nameUse here
/xiaohongshu/profile/postsxiaohongshu.profile_posts
/xiaohongshu/post/commentsxiaohongshu.post_comments

Yelp#

Path-style nameUse here
/yelp/business/infoyelp.business
/yelp/business/reviewsyelp.reviews
/yelp/search/fullyelp.search_full
/yelp/search/suggestionsyelp.search_suggestions

YouTube#

Path-style nameUse here
/youtube/channel/aboutyoutube.channel_about
/youtube/channel/videosyoutube.channel_videos
/youtube/videosyoutube.videos_batch
/youtube/channelsyoutube.channels_batch
/youtube/transcriptsyoutube.transcript
/youtube/video/sponsorsyoutube.video_sponsors
/youtube/video/commentsyoutube.video_comments
/youtube/video/comment/repliesyoutube.comment_replies
/youtube/channel/shortsyoutube.channel_shorts
/youtube/community-postyoutube.community_post
/youtube/search/hashtagyoutube.search_hashtag
/youtube/shorts/trendingyoutube.shorts_trending
/youtube/video/transcriptyoutube.transcript
/youtube/channel/playlistsyoutube.channel_playlists
/youtube/channel/livesyoutube.channel_streams, youtube.search_live
/youtube/channel/community-postsyoutube.channel_posts
/youtube/videos/trendingyoutube.trending
/youtube/playlist/itemsyoutube.playlist_items
/youtube/search/advancedyoutube.search
/youtube/search/suggestionsyoutube.suggest
/youtube/video/thumbnailsyoutube.video_thumbnails
/youtube/profile/fullyoutube.channel, youtube.channel_videos

Not here#

Some capabilities have no equivalent yet, for example asynchronous job queues, uploaded audience panels and a few reference lists. If one is blocking you, tell us.