Browsable Browsable Docs
Staging API reference. Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev.

API Reference

Core API operations plus currently available prebuilt endpoints. See the request, pagination and error guide before integrating. Download the prebuilt catalogue OpenAPI specification for client generation; core and compatibility routes are documented below.

Some prebuilt endpoints require a managed website login. For those endpoints, Browsable automatically uses a saved login when one is available, or returns 428 Authentication required with a hosted_url you can open to complete sign-in.

Machine-readable docs: llms.txt.

Core Platform Endpoints

GET /v1/auth/invocations/:id

Inspect a website authentication flow.
POST /v1/instagram/scrape

Legacy Instagram compatibility route; prefer the catalogue APIs.
POST /v1/integration-assets

Upload a private integration image asset.
GET /v1/integration-assets/:id

Read a private integration image asset.
POST /v1/runs/:id/cancel

Cancel a supported integration run.
POST /v1/tasks/:task_key/edits

Retired: create a replacement API from the dashboard (HTTP 410).
POST /v1/task-generations/:id/continue-auth

Retired: legacy generation cannot be resumed (HTTP 410).
GET /v1/task-generations/:id/endpoints

List published endpoints for an existing generation.
GET /v1/task-generations/:id/evidence

Read available evidence for an existing generation.
GET /v1/tasks/:task_key/options

Find published filter values and labels.
POST /v1/task-generations

Retired: create replacement APIs from the dashboard (HTTP 410).
GET /v1/tasks

List tasks accessible to your API key.
GET /v1/tasks/:task_key

Fetch canonical task metadata by task key.
POST /v1/tasks/:task_key/runs

Execute a task by canonical task key.
GET /v1/task-generations/:id

Read an existing generation record.
GET /v1/runs/list

List runs for your team and filters.
GET /v1/runs/:id

Fetch a single run payload and status.
GET /v1/runs/:id/logs

Fetch run logs, including auth workflow events.
GET /v1/website-logins

List external website logins available to tasks.
POST /v1/website-logins

Start a hosted external website login flow.
DELETE /v1/website-logins/:id

Delete an external website login account.
GET /v1/website-logins/invocations/:id

Poll a hosted external website login flow.
DELETE /v1/website-logins/invocations/:id

Cancel a hosted external website login flow.
GET /v1/website-logins/location

Fetch the team location used for website login setup.
PATCH /v1/website-logins/location

Set or reset the team location used for website login setup.

Available Prebuilt APIs

Airbnb

POST /v1/airbnb/calendar

Airbnb calendar

Read public calendar availability and exposed stay restrictions. Unavailable does not mean booked; prices are displayed calendar prices, not stay quotes.
POST /v1/airbnb/host

Airbnb host

Read a public Airbnb host profile. Only publicly exposed attributes are returned; unknown fields remain null.
POST /v1/airbnb/host/listings

Airbnb host listings

Read publicly exposed stays on an Airbnb host profile, with explicit pagination and completeness. Does not infer hidden listings.
POST /v1/airbnb/reviews

Airbnb reviews

Read paginated public listing reviews, rating summary and host responses. Missing upstream review data fails explicitly.
POST /v1/airbnb/room

Airbnb room

Fetch an Airbnb room/listing page and return normalized details, photos, host info, amenities, reviews, policies, and availability.
POST /v1/airbnb/search

Airbnb search

Search Airbnb stay results for a destination/date combination and return normalized listings with cursor pagination.

Amazon

POST /v1/amazon/asin

Amazon ASIN Lookup API

Fetch product details, specifications, images, price and availability by ASIN or URL. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/best-sellers

Amazon Best Sellers API

Fetch Amazon Best Sellers by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/deals

Amazon Deals API

Fetch public deals, or search for products with active deal badges. Query pages can be empty after filtering; continue while next_cursor is present. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/movers-and-shakers

Amazon Movers and Shakers API

Fetch Amazon Movers and Shakers by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/new-releases

Amazon New Releases API

Fetch Amazon New Releases by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/price

Amazon Product Price API

Fetch the current product price and availability by ASIN or URL. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/product/offers

Amazon Product Offers API

Compare public seller offers, item condition, shipping and Featured Offer status for a product. Total prices are null when shipping cannot be determined. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/product/reviews Auth required

Amazon Reviews
POST /v1/amazon/product/variations

Amazon Product Variations API

List related child ASINs and their size, colour and style attributes. Set include_details to fetch each variant's current price and availability (maximum 10 per request). Without it, only the selected variant has product details. Costs 10 credits. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/products/batch

Amazon Products Batch API

Fetch up to 10 products by ASIN. Duplicate ASINs are fetched once. Partial batches include per-product errors; all-failed batches fail. Costs 10 credits. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/search

Amazon Search API

Search Amazon products with price, rating, brand and category filters, sorting, and continuation cursors. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.
POST /v1/amazon/seller/products

Amazon Seller Products API

Browse a public seller's product catalogue by merchant ID, with optional search, filters, sorting and continuation cursors. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.

Booking

POST /v1/booking/hotel

Booking.com Hotel API

Scrape hotel details and dated room offers with occupancy, cancellation, meals, payment and tax text. Supply checkin, checkout, group_adults, group_children, no_rooms and selected_currency in the URL. Displayed prices may exclude taxes. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.
POST /v1/booking/search

Booking.com API

Scrape public Booking.com accommodation search results by destination. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.

Ebay

POST /v1/ebay/item

eBay Item API

Read the exact public ebay.com listing by item URL or id, including displayed price, condition, images and seller feedback. Listing sold counters are not a transaction history. eBay may restrict anonymous access.
POST /v1/ebay/search

eBay Search API

Search public active ebay.com listings, including displayed prices and seller feedback when available. Does not search sold/completed listings. eBay may restrict anonymous access.
POST /v1/ebay/seller

eBay Seller API

Read an ebay.com seller's public feedback score, positive percentage, registration date, rating counts and detailed seller ratings. No website login required; eBay may restrict anonymous access.
POST /v1/ebay/seller-feedback

eBay Seller Feedback API

Read paginated feedback received as an ebay.com seller, including comments, rating, displayed date, item reference and available seller replies. Supports positive, neutral or negative feedback filters; filtered pages may contain fewer results, so follow next_cursor even when count is zero. Feedback prices are displayed references, not a sold-listings price history.
POST /v1/ebay/seller-listings

eBay Seller Listings API

Search an ebay.com seller's active listings, optionally filtered by keywords, condition, price and category, with cursor pagination. Does not return sold/completed history.

Googlemaps

POST /v1/googlemaps/area

Google Maps area search

Search Google Maps for businesses near a specific latitude/longitude. Useful for exhaustive geographic coverage where IP-based location guessing would be unreliable.
POST /v1/googlemaps/autocomplete

Google Maps Autocomplete API

Fetch public Google Maps autocomplete suggestions.
POST /v1/googlemaps/place

Google Maps place

Fetch full details for a single Google Maps place — name, rating, category, description, address, phone, website, plus code, opening hours, and coordinates.
POST /v1/googlemaps/reviews

Google Maps reviews

Fetch reviews for a Google Maps place — author, rating, date, text, owner response, plus an overall rating breakdown.
POST /v1/googlemaps/search

Google Maps search

Search Google Maps for businesses or places matching a query and return each result's name, rating, category, address, hours, place ID, and coordinates.

Instagram

POST /v1/instagram/feed Auth required

Instagram Authenticated Feed

Fetch your Instagram home feed using a managed website login for instagram.com.
POST /v1/instagram/hashtag-posts

Instagram Hashtag Posts

Retrieve public Instagram posts for a hashtag. This endpoint does not retrieve posts tagging a user.
POST /v1/instagram/profile

Instagram Public Profile

Fetch a public Instagram profile anonymously, including profile metadata and paginated posts.
POST /v1/instagram/profile-download

Instagram Profile Download

Export a full public Instagram profile as a ZIP file with media, captions, post metadata, manifest.json, and posts.csv. Authenticated runs are recommended in async mode. Pricing depends on account eligibility and profile size. See the Instagram profile downloader in your dashboard for your starting price.
POST /v1/instagram/public-profile

Instagram Public Profile (No Auth)

Fetch a public Instagram profile anonymously, including profile metadata and paginated posts.
POST /v1/instagram/reels

Instagram Reels API

Scrape public Instagram reels from a profile.

Mercari

POST /v1/mercari/listing

Mercari Listing API

Get a Mercari US listing’s title, price, photos, condition and seller name.
POST /v1/mercari/search

Mercari Search API

Search Mercari US listings with price, brand, category, condition and status filters. Follow next_cursor to get more results.
POST /v1/mercari/seller

Mercari Seller API

Get a public Mercari US seller profile, ratings, follower counts and selling statistics.
POST /v1/mercari/seller/listings

Mercari Seller Listings API

Get a Mercari US seller’s listings with keyword, price, brand, category, condition and status filters. Follow next_cursor to get more results.
POST /v1/mercari/seller/reviews

Mercari Seller Reviews API

Get public Mercari US account feedback, newest first. Choose reviews from buyers or sellers. Automated Mercari messages are labelled.

Offerup

POST /v1/offerup/item

OfferUp Item API

Read an OfferUp listing's full description, photos, condition code, price and available seller trust summary. No website login required. Removed listings may be unavailable.
POST /v1/offerup/search

OfferUp Search API

Search OfferUp listings near a US city and state or ZIP code. Location is resolved automatically. Returns prices, locations, images and pickup information with cursor pagination. Seller ratings and cancellations are not included in OfferUp's search feed.
POST /v1/offerup/seller

OfferUp Seller API

Read a public OfferUp seller profile, including available ratings, account age, activity, response time, badges and compliments. Missing metrics are null; cancellation rates are not available.
POST /v1/offerup/seller-listings

OfferUp Seller Listings API

Browse a public OfferUp seller's active listings with cursor pagination. Keep seller_id and limit unchanged when continuing.

Onlyfans

POST /v1/onlyfans/profile

OnlyFans API

Fetch public OnlyFans profile details, subscription pricing and visible counts without connecting an OnlyFans account. Hidden counts are null; restricted profiles may be unavailable.
POST /v1/onlyfans/profiles

OnlyFans Profiles API

Fetch public details for up to 10 OnlyFans profiles without connecting an account. Duplicate usernames are fetched once. Partial batches include per-profile errors; all-failed batches fail the run. Costs 10 credits per batch.
POST /v1/onlyfans/search

OnlyFans Creator Search API

Discover OnlyFans creator profile links and snippets from Google's search index. No OnlyFans login needed. Coverage is not exhaustive and snippets may be outdated; use the profile endpoint for current data. A page can contain fewer results or be empty after non-profile links are excluded; continue while next_cursor is present.

Patreon

POST /v1/patreon/campaign

Patreon Campaign API

Fetch public Patreon creator details, visible counts, membership tiers and goals. Hidden earnings remain null.
POST /v1/patreon/creator

Patreon Creator API

Scrape public Patreon creator metadata.
POST /v1/patreon/creator-download

Patreon Creator Download

Export a Patreon creator's posts and accessible media as a ZIP file. Managed Patreon auth is optional and recommended for paid content your account can view.
POST /v1/patreon/creator-posts

Patreon Creator Posts API

Fetch public Patreon post metadata from a creator by username, URL, or campaign id.
POST /v1/patreon/post

Patreon Post API

Fetch public Patreon post details by post URL.
POST /v1/patreon/post-media

Patreon Post Media API

Extract public media and attachment metadata from a Patreon post by post URL.
POST /v1/patreon/search

Patreon Search API

Search public Patreon creators by query with page pagination.

Tiktok

POST /v1/tiktok/comments Auth required

TikTok comments

Get comments for a TikTok video using a connected TikTok account. The current website requires sign-in to open comments; video and profile metadata remain available through the public endpoints.
POST /v1/tiktok/follower-count

TikTok Follower Count

Get public follower counts and profile statistics for a TikTok username. Individual follower identities are not returned.
POST /v1/tiktok/hashtag

TikTok hashtag

Fetch public hashtag metadata and a paginated slice of rendered public videos for a TikTok hashtag.
POST /v1/tiktok/profile

TikTok profile

Fetch public TikTok profile metadata and a paginated slice of recent public videos from a creator profile.
POST /v1/tiktok/search

TikTok search

Fetch a paginated slice of public rendered TikTok video search results for a query.
POST /v1/tiktok/video

TikTok video

Fetch public metadata, stats, media, music, hashtags, and author data for a TikTok video.
POST /v1/tiktok/videos

TikTok videos

Fetch a paginated slice of public videos from a TikTok creator profile.

Vinted

POST /v1/vinted/brand

Vinted Brand Feed API

Scrape public Vinted catalog results for a brand.
POST /v1/vinted/item

Vinted item

Fetch a Vinted item page and return normalized item details plus similar items from the same page.
POST /v1/vinted/member/items

Vinted member items

Fetch a Vinted member wardrobe feed with pagination and normalized item data.
POST /v1/vinted/member/search

Vinted member search

Search Vinted member profiles by username and return normalized member matches across multiple pages.
POST /v1/vinted/search

Vinted search

Search Vinted listings by keyword and return normalized item data across multiple pages.
POST /v1/vinted/search/filtered

Vinted filtered search

Search Vinted listings with catalog, size, brand, condition, color, pattern, material, price, and sort filters.

Youtube

POST /v1/youtube/channel/email Auth required

YouTube channel email

Reveal the protected public business email from a YouTube channel's about panel using a managed signed-in browser.
POST /v1/youtube/channel/shorts

YouTube channel shorts

Fetch shorts from a YouTube channel shorts tab using the public web client sort chips and continuations.
POST /v1/youtube/channel/videos

YouTube channel videos

Fetch videos from a YouTube channel videos tab using public web continuations.
POST /v1/youtube/livestreams

YouTube Livestreams API

Scrape public YouTube live video search results.
POST /v1/youtube/search

YouTube search

Search YouTube and return normalized mixed results from the default results page.
POST /v1/youtube/to-mp3

YouTube to MP3

Convert a public YouTube video to a downloadable MP3 file.
POST /v1/youtube/transcript

YouTube Transcript API

Fetch public YouTube caption transcript segments for a video.
POST /v1/youtube/video

YouTube video

Fetch a YouTube video page with normalized metadata and top-level comments.
POST /v1/youtube/video/comments

YouTube video comments

Fetch top-level comments for a YouTube video using the public watch page and comments continuations.