OpenAny
Server Details
The marketplace for agents: 168+ AI models, 3,200+ APIs, one key. No subscription, pay per call.
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-11-25
- URL
- ChatGPT
- –
- Claude
- –
TDQS
Score is being calculated.
Available Tools
3256 toolsaccurlex_post_law_search_deep_accurlex_law_searchaccurLex - Statute Search - Free Deep ModeInspect
Retrieve relevant Chinese statutory and judicial-interpretation text and sources from a natural-language request or case facts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve relevant Chinese statutory and judicial-interpretation text and sources from a natural-language request or case facts. |
accurlex_post_law_search_expert_accurlex_law_searchaccurLex - Statute Search - Promotional Expert ModeInspect
Retrieve relevant Chinese statutory and judicial-interpretation text and sources from a natural-language request or case facts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve relevant Chinese statutory and judicial-interpretation text and sources from a natural-language request or case facts. |
accurlex_post_qa_deep_accurlex_legal_qaaccurLex - Legal QA - Free Deep ModeInspect
Analyze a question about Chinese law using retrieved statutory material. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Analyze a question about Chinese law using retrieved statutory material. |
aihot_get_api_v1_agent_codex_resetsAIHOT — Codex resets as an agent answerInspect
Announcements still waiting to land, the last 7 days of resets and reset credits, the latest landed one and any acknowledged outage, in Beijing time. It never predicts the next reset. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_daily_dateAIHOT — A dated daily report as an agent answerInspect
A real YYYY-MM-DD date; a date without a report is 404, never another day's report. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_hotAIHOT — Current hot topics as an agent answerInspect
The current Top 10 by rank, each with the address of its story answer. No heat values. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_latestAIHOT — Latest items as an agent answerInspect
The same items as /api/v1/items (timeline order), rendered for an agent to relay: titles linked to AIHOT, source, Beijing time, summary and reason. Defaults to the editorial picks of the past 24 hours, 10 items. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | ||
| limit | No | ||
| window | No | ||
| category | No | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_latest_dailyAIHOT — The latest daily report as an agent answerInspect
The latest daily report as an agent answer Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_monthlyAIHOT — The latest monthly report as an agent answerInspect
The most recent monthly report in Chinese Markdown: headline, overview and the month's most important items by section, with answering hints. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_monthly_by_month_monthAIHOT — A monthly report as an agent answerInspect
A real month such as 2026-09; a month without a report is 404, never another month's report. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| month | Yes | Calendar month, e.g. 2026-09. | |
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_searchAIHOT — Search as an agent answerInspect
Searches the editorial picks first and, only when they have nothing, every public item, and says which. Defaults to the latest 7 days. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | ||
| limit | No | ||
| window | No | ||
| category | No | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_story_publicidAIHOT — A story's timeline as an agent answerInspect
Latest development, AI digest, reports from newest to oldest and related stories. Only use addresses given by /api/v1/agent/hot or another story answer. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| publicId | Yes | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_weeklyAIHOT — The latest weekly report as an agent answerInspect
The most recent weekly report in Chinese Markdown: headline, overview and the week's most important items by section, with answering hints. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_agent_weekly_by_week_weekAIHOT — A weekly report as an agent answerInspect
A real ISO week such as 2026-W39; a week without a report is 404, never another week's report. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| week | Yes | ISO week label, e.g. 2026-W39. | |
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_codex_resetsAIHOT — List Tibo Codex reset and reset-credit eventsInspect
Current full public calendar snapshot, sorted by updatedAt descending. Includes explicit announcements and confirmed direct resets or reset-credit grants, Chinese source quotes and original links. No query parameters. Replace your previous snapshot; event grouping and receipts may be corrected, withdrawn events disappear. Timestamps use +08:00 (Asia/Shanghai). confirmedAt is the confirmation post time, not an exact execution time; occurredOn is a separately verified date or null. schedule remains the original estimate even after confirmation. Unknown times remain null. No account quota or pred Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_codex_resets_recentAIHOT — Recent Tibo Codex reset events for pollingInspect
The polling form of /api/v1/codex-resets, in the same shape: events updated within the last 7 Beijing days plus every event still waiting to land (announced, in progress or just past its window), and the source posts of those 7 days. historyFrom is the start of that window. No query parameters. A few KB instead of the whole history; the full snapshot remains at /api/v1/codex-resets. Replace your previous copy on every change; timestamps use +08:00 (Asia/Shanghai). Poll every 10 minutes using If-None-Match and Accept-Encoding: gzip or br: an unchanged answer is a 304 with an empty body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_dailiesAIHOT — List daily-report archive entriesInspect
Date index of past daily reports, newest first. Reports are published once a day at 08:00 Asia/Shanghai, so checking this more than a few times a day is wasted work. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_daily_by_date_dateAIHOT — Get a daily report by Shanghai calendar dateInspect
A single past daily report by Asia/Shanghai calendar date (YYYY-MM-DD). Reports are edited once, but withdrawn citations are removed from later responses. Respect Cache-Control and revalidate with If-None-Match before reusing an expired copy; do not cache a report indefinitely. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_hot_topicsAIHOT — List current multi-source hot topicsInspect
AIHOT — List current multi-source hot topics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_itemsAIHOT — List recent public AI itemsInspect
Start here for feeds, widgets and 'what is new' views. Covers the last 7 days only. Send If-None-Match and you get a 304 with an empty body whenever nothing changed. To follow new items, page back with cursor only until you reach an id you already have. Do not use this to maintain a complete local copy of the selected set: it is windowed, so anything older than 7 days silently falls out. Use /api/v1/selected/snapshot plus /api/v1/selected/changes for that. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Leading and trailing whitespace is removed before validation; the remaining value must contain 2 to 200 Unicode code points. | |
| by | No | Which timeline defines the window and ordering. 'timeline' (default) matches the site's published timeline: historical or explicitly backfilled items can retain their source publication date, and items first found more than 72h after publication retain that date unless the editors admit them as current news, at their admission time. Ordinary new items use discovery time; selected representatives follow their reading group's first appearance. 'published' uses the source publication time, falling back to receipt time when that date is unknown. Every item returns publishedAt (null when unknown) and discoveredAt (receipt time); these attribution timestamps do not replace the opaque pagination cursor. | |
| mode | No | ||
| limit | No | ||
| cursor | No | Opaque, query-bound keyset cursor for the rolling window. It carries no issue time and does not expire on a timer, but the window keeps moving: once the cursor's own anchor has dropped out of the requested 24h or 7d window it is rejected with invalid_cursor, so restart the query from the first page instead of persisting a cursor across days. Older rows may also naturally leave the window between requests. Use selected snapshot + changes for an exact mirror. | |
| window | No | ||
| category | No | Current values: ai-models, ai-products, industry, paper, tip, opinion. Use tip for tutorials and opinion for opinions; these match the website categories. | |
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_latest_dailyAIHOT — Get the latest daily reportInspect
The most recent daily report, published once a day at 08:00 Asia/Shanghai. A client that only wants the daily digest should wake up shortly after 08:00 rather than poll around the clock. Agent or tool runtimes that cache a stable URL beyond HTTP cache headers should first request /api/v1/dailies?limit=1 and then fetch /api/v1/dailies/{returned-date}; never guess a date. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_latest_monthlyAIHOT — Get the latest monthly reportInspect
The most recent monthly report: its headline, overview and the month's most important items grouped by section, chosen from that month's dailies. Published on the 1st of each month at 10:30 Asia/Shanghai. Tool runtimes that cache a stable URL should first request /api/v1/monthlies?limit=1 and then /api/v1/monthlies/{returned-month}; never guess a month. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_latest_weeklyAIHOT — Get the latest weekly reportInspect
The most recent weekly report: its headline, overview and the week's most important items grouped by section, chosen from that week's dailies. Published each Monday at 10:00 Asia/Shanghai; a client that wants the weekly digest should fetch it shortly after that rather than poll. Agent or tool runtimes that cache a stable URL beyond HTTP cache headers should first request /api/v1/weeklies?limit=1 and then /api/v1/weeklies/{returned-week}; never guess a week. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_monthliesAIHOT — List monthly reportsInspect
Index of published monthly reports, newest first: month, its first and last day, headline and AIHOT link. A monthly is published on the 1st of each month at 10:30 Asia/Shanghai, compiled from the dailies dated in that month. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_monthly_by_month_monthAIHOT — Get a monthly report by monthInspect
A single monthly report by calendar month (YYYY-MM, for example 2026-09). Withdrawn citations are removed from later responses. Respect Cache-Control and revalidate with If-None-Match before reusing an expired copy. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| month | Yes | Calendar month, e.g. 2026-09. | |
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_selected_changesAIHOT — Fetch atomic selected-item changesInspect
Adds, edits and removals since your cursor, so a local copy stays correct without re-downloading anything. Apply a page, then save the returned cursor — never the other way round. The cursor is a ledger watermark, not a session: it does not expire on a timer, so a client may go offline for days and resume exactly where it stopped. On 409 snapshot_required, re-bootstrap from /api/v1/selected/snapshot; that response is the only signal that resuming is no longer safe. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| cursor | Yes | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_story_by_public_id_publicidAIHOT — Get a story (event) with its coverage timeline and AI digestInspect
One story = one real-world event aggregated from every covering source: a reverse-chronological coverage timeline, an AI digest that is rewritten incrementally as the event evolves (contradictions with earlier reporting are stated explicitly), and links to same-storyline and related stories. Extract ids from the final path segment of a hot-topics links.story HTML URL, or use ids from another story's storyline/related refs; never request links.story as JSON. Merged stories answer with a 308 to the surviving id. Call this endpoint only with an id actually returned by the API; a 404 means the pub Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| publicId | Yes | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_weekliesAIHOT — List weekly reportsInspect
Index of published weekly reports, newest first: ISO week, its Monday-to-Sunday days, headline and AIHOT link. A weekly is published each Monday at 10:00 Asia/Shanghai, compiled from the dailies dated in that week, so checking more than once a day is wasted work. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
aihot_get_api_v1_weekly_by_week_weekAIHOT — Get a weekly report by ISO weekInspect
A single weekly report by ISO week label (YYYY-Www, for example 2026-W39). Withdrawn citations are removed from later responses. Respect Cache-Control and revalidate with If-None-Match before reusing an expired copy; do not cache a report indefinitely. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| week | Yes | ISO week label, e.g. 2026-W39. | |
| User-Agent | No | User-Agent | |
| If-None-Match | No | Previously received ETag for this exact URL. A match returns 304 without a response body. |
alchemy_get_nft_v3_getcontractmetadataAlchemy — Contract Metadata By AddressInspect
getContractMetadata - Retrieves high-level collection or contract-level information for an NFT. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks here. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| contractAddress | Yes | String - Contract address for the NFT contract (ERC721 and ERC1155 supported). |
alchemy_get_nft_v3_getcontractsforownerAlchemy — Contracts By OwnerInspect
getContractsForOwner - Retrieves all NFT contracts held by a specified owner address. Free import profile omits optional paid filters and query names unsupported by the importer; see retained original documentation. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | String - Address for NFT owner (can be in ENS format for Eth Mainnet). | |
| orderBy | No | Enum - ordering scheme to use for ordering NFTs in the response. If unspecified, NFTs will be ordered by contract address and token ID. - transferTime: NFTs will be ordered by the time they were transferred into the wallet, with newest NFTs first. Note: This ordering is supported on Ethereum Mainnet, Optimism Mainnet, Polygon Mainnet, Base Mainnet, Arbitrum One, Polygon Amoy, Base Sepolia, Arbitrum Sepolia, Ethereum Sepolia, and Optimism Sepolia. | |
| pageKey | No | String - key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results. | |
| pageSize | No | Number of NFTs to be returned per page. Defaults to 100. Max is 100. | |
| withMetadata | No | Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`. |
alchemy_get_nft_v3_getfloorpriceAlchemy — Floor Prices By SlugInspect
Retrieves the floor prices of an NFT collection across different marketplaces. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionSlug | No | String - OpenSea slug for the NFT collection. | |
| contractAddress | Yes | String - Contract address for the NFT contract (ERC721 and ERC1155 supported). |
alchemy_get_nft_v3_getnftmetadataAlchemy — NFT Metadata By Token IDInspect
getNFTMetadata - Retrieves the metadata associated with a specific NFT. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks here. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tokenId | Yes | String - The ID of the token. Can be in hex or decimal format. | |
| tokenType | No | String - 'ERC721' or 'ERC1155'; specifies type of token to query for. API requests will perform faster if this is specified. | |
| refreshCache | No | Defaults to false for faster response times. If true will refresh metadata for given token. If false will check the cache and use it or refresh if cache doesn't exist. | |
| contractAddress | Yes | String - Contract address for the NFT contract (ERC721 and ERC1155 supported). | |
| tokenUriTimeoutInMs | No | No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0. |
alchemy_get_nft_v3_getnftsforcontractAlchemy — NFTs By ContractInspect
getNFTsForContract - Retrieves all NFTs associated with a specific NFT contract. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks here. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Integer - Sets the total number of NFTs returned in the response. Defaults to 100. | |
| startToken | No | String - A tokenID offset used for pagination. Can be a hex string, or a decimal. Users can specify the offset themselves to start from a custom offset, or to fetch multiple token ranges in parallel. | |
| withMetadata | No | Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`. | |
| contractAddress | Yes | String - Contract address for the NFT contract (ERC721 and ERC1155 supported). | |
| tokenUriTimeoutInMs | No | No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0. |
alchemy_get_nft_v3_getnftsforownerAlchemy — NFTs By OwnerInspect
getNFTsForOwner - Retrieves all NFTs currently owned by a specified address. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks here. Free import profile omits optional paid filters and query names unsupported by the importer; see retained original documentation. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | String - Address for NFT owner (can be in ENS format for Eth Mainnet). | |
| orderBy | No | Enum - ordering scheme to use for ordering NFTs in the response. If unspecified, NFTs will be ordered by contract address and token ID. - transferTime: NFTs will be ordered by the time they were transferred into the wallet, with newest NFTs first. Note: This ordering is supported on Ethereum Mainnet, Optimism Mainnet, Polygon Mainnet, Base Mainnet, Arbitrum One, Polygon Amoy, Base Sepolia, Arbitrum Sepolia, Ethereum Sepolia, and Optimism Sepolia. | |
| pageKey | No | String - key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results. | |
| pageSize | No | Number of NFTs to be returned per page. Defaults to 100. Max is 100. | |
| withMetadata | No | Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`. | |
| tokenUriTimeoutInMs | No | No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0. |
alchemy_get_nft_v3_getownersforcontractAlchemy — Owners By ContractInspect
getOwnersForContract - Retrieves all owners associated with a specific NFT contract. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks here. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pageKey | No | String - used for contracts with >50,000 owners. `pageKey` field can be passed back as request parameter to get the next page of results. | |
| contractAddress | Yes | String - Contract address for the NFT contract (ERC721 and ERC1155 supported). | |
| withTokenBalances | No | Boolean - If set to `true` the query will include the token balances per token id for each owner. `false` by default. |
alchemy_get_nft_v3_getownersfornftAlchemy — Owners By NFTInspect
getOwnersForNFT - Retrieves the owner(s) for a specific token. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks here. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tokenId | Yes | String - The ID of the token. Can be in hex or decimal format. | |
| contractAddress | Yes | String - Contract address for the NFT contract (ERC721 and ERC1155 supported). |
alchemy_post_nft_v3_getcontractmetadatabatchAlchemy — Contract Metadata By Address [Batch]Inspect
getContractMetadataBatch - Retrieves metadata for a list of specified contract addresses in a single request. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | getContractMetadataBatch - Retrieves metadata for a list of specified contract addresses in a single request. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. |
alchemy_post_nft_v3_getnftmetadatabatchAlchemy — NFT Metadata By Token ID [Batch]Inspect
getNFTMetadataBatch - Retrieves metadata for up to 100 specified NFT contracts in a single request. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks here. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | getNFTMetadataBatch - Retrieves metadata for up to 100 specified NFT contracts in a single request. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains). Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. |
alchemy_post_prices_v1_tokens_by_addressAlchemy — Token Prices By AddressInspect
Fetches current prices for multiple tokens using network and address pairs. Returns a list of token prices, each containing the network, address, prices, and an optional error field. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Fetches current prices for multiple tokens using network and address pairs. Returns a list of token prices, each containing the network, address, prices, and an optional error field. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. |
alchemy_post_prices_v1_tokens_historicalAlchemy — Historical Token PricesInspect
Provides historical price data for a single token over a time range. You can identify the token by symbol or by network and contract address. Uses the shared Alchemy Free quota; not unlimited. Documentation prepared only, not runtime-verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Request body for fetching historical token prices. Provide either the token `symbol` or both `network` and `address`, along with the required time range parameters. |
anyapi_post_v1_run_ahrefs_backlinksAhrefs BacklinksInspect
Get the referring pages linking to a domain or URL, each with the source page, anchor text, linking domain rating, and page title. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The domain or page URL to find backlinks for (e.g. "ahrefs.com"). | |
| mode | No | Match scope: "exact" for the given URL only, or "subdomains" to include the domain and its subdomains. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_airbnb_searchAirbnb SearchInspect
Search Airbnb listings by location and dates with optional price, beds/bedrooms/bathrooms, and guest-party filters and get results (name, total-stay price label, rating, host) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| pets | No | Number of pets; only pet-friendly listings are returned when set (e.g. 1). | |
| limit | No | Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less. | |
| adults | No | Number of adult guests (e.g. 2). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| checkIn | No | Check-in date in YYYY-MM-DD format (e.g. 2026-07-01). | |
| infants | No | Number of infant guests (e.g. 1). | |
| minBeds | No | Minimum number of beds (e.g. 2). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| checkOut | No | Check-out date in YYYY-MM-DD format (e.g. 2026-07-05). | |
| children | No | Number of child guests (e.g. 1). | |
| currency | No | Currency code for prices (e.g. EUR). | |
| location | Yes | Location to search listings in (e.g. London). | |
| priceMax | No | Maximum search price in the selected currency (e.g. 300). | |
| priceMin | No | Minimum search price in the selected currency (e.g. 50). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| minBedrooms | No | Minimum number of bedrooms (e.g. 2). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| minBathrooms | No | Minimum number of bathrooms (e.g. 2). | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_alibaba_searchAlibaba SearchInspect
Search Alibaba by keyword and get up to 25 wholesale listings (title, price range, minimum order, and supplier) in one normalized response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-25, default 25). You are billed per result returned, so a lower limit costs less. | |
| query | Yes | Keywords to search for on Alibaba (e.g. "bluetooth speaker wholesale"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_amazon_bestsellersAmazon BestsellersInspect
List the top-ranked products of any Amazon Best Sellers category (rank, title, price, and rating) in one normalized request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Amazon Best Sellers category URL (e.g. https://www.amazon.com/Best-Sellers-Electronics/zgbs/electronics). | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `offersCount` or `categoryName`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_amazon_productAmazon ProductInspect
Fetch full Amazon product details (title, brand, price when in stock, images, ratings, review count, variants, and attributes) from a product URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full Amazon product URL (e.g. https://www.amazon.com/dp/B0CX23V2ZK). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `category` or `condition`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_amazon_reviewsAmazon ReviewsInspect
Pull up to 50 customer reviews for any Amazon product by ASIN or URL: rating, title, text, date, and verified-purchase badge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Review sort order: most helpful first or most recent first (e.g. recent). | |
| limit | No | Maximum number of results to return (1-50, default 50). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | Amazon marketplace domain the product ASIN belongs to (e.g. amazon.co.uk). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| endDate | No | Only return reviews on or before this date, inclusive, in YYYY-MM-DD format (e.g. 2026-06-30). | |
| keyword | No | Only return reviews whose title or text contains this keyword, case-insensitively (e.g. battery). | |
| product | Yes | Amazon product ASIN or full product URL (e.g. B07CMS5Q6P). | |
| ratings | No | Only return reviews whose star rating is in this set (e.g. ["5", "4"] for 4 and 5 star reviews); omit for all ratings. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Only return reviews on or after this date, inclusive, in YYYY-MM-DD format (e.g. 2026-01-01). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| verifiedOnly | No | Set true to return only verified-purchase reviews (e.g. true). | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `url`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a review that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_amazon_searchAmazon SearchInspect
Search Amazon from any search or category URL and get up to 20 matching products (title, price, rating, and thumbnail) in one normalized response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Amazon search or category URL. For U.S. URLs, include page to select an Amazon results page; limit caps that page. Supported keyword, category, price, brand, rating and Prime selectors and standard Amazon sort orders are preserved. Unsupported selectors are rejected. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_apollo_organizationApollo OrganizationInspect
Get a complete organization profile by ID including company, industry, employee, monthly headcount flow, revenue, funding rounds, ownership, location, and technology data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| organizationId | Yes | Organization identifier returned by an Apollo organization endpoint. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_apollo_organization_enrichApollo Organization EnrichmentInspect
Enrich an organization by domain, optionally with its LinkedIn URL, website, or name, with company profile, industry, headcount growth, department headcount, revenue, funding rounds, location, and technology data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| name | No | Organization name, which improves match accuracy. | |
| domain | Yes | Organization domain without a path, such as apollo.io. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| website | No | Full website URL, which Apollo also matches on. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| linkedinUrl | No | LinkedIn company page URL, which Apollo also matches on. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_apollo_organization_jobsApollo Organization JobsInspect
Get current job postings for an organization by ID with title, location, source URL, and timestamps, one page at a time. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | One-based result page. | |
| limit | No | Maximum job postings returned on this page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| organizationId | Yes | Organization identifier returned by an Apollo organization endpoint. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_apollo_organization_newsApollo Organization NewsInspect
Search news related to one or more organizations, optionally by category and publish date range, with article details, categories, and pagination totals. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | One-based result page. | |
| limit | No | Maximum articles returned on this page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | No | Optional keywords to match in related articles. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| categories | No | News categories or sub-categories to match, such as hires, investment or contract. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| publishedAtGte | No | Only articles published on or after this date. Format: YYYY-MM-DD. | |
| publishedAtLte | No | Only articles published on or before this date. Format: YYYY-MM-DD. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| organizationIds | Yes | Organization identifiers whose related news should be returned. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_apollo_organizations_bulk_enrichApollo Bulk Organization EnrichmentInspect
Enrich up to 10 organization domains in one request with normalized company profile, industry, employee, revenue, and location data. Priced per request rather than per domain, so a full batch of 10 costs the same as a batch of 1. Results are positionally aligned with the domains you send, and a domain with no match returns null in its slot. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| domains | Yes | Organization domains to enrich, with at most 10 domains per request. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_apollo_organizations_searchApollo Organization SearchInspect
Search organizations by location, employee range, industry, keywords, domain, name, revenue, funding, technology, hiring activity, headcount growth, or lookalike seeds, with normalized company records and pagination totals. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| name | No | Organization name to match; partial matches count. | |
| page | No | One-based result page. | |
| limit | No | Maximum organizations returned on this page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| domains | No | Organization domains to match, without www, at most 1000. | |
| maxJobs | No | Maximum number of active job postings at the organization. | |
| minJobs | No | Minimum number of active job postings at the organization. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | No | Keywords to match across organization records. | |
| locations | No | Headquarters locations to match. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| industryIds | No | Apollo industry tag identifiers to match. | |
| keywordTags | No | Keywords associated with the organization, such as mining or consulting. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| maxFundingUsd | No | Maximum total funding across all rounds, in whole USD. | |
| maxRevenueUsd | No | Maximum organization annual revenue, in whole USD with no symbols. | |
| minFundingUsd | No | Minimum total funding across all rounds, in whole USD. | |
| minRevenueUsd | No | Minimum organization annual revenue, in whole USD with no symbols. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| employeeRanges | No | Employee-count ranges in Apollo notation, such as 51,200. | |
| excludeDomains | No | Exclude organizations matching any of these domains. Every domain Apollo holds for that organization is excluded. | |
| jobPostedAtGte | No | Only organizations with a job posted on or after this date. Format: YYYY-MM-DD. | |
| jobPostedAtLte | No | Only organizations with a job posted on or before this date. Format: YYYY-MM-DD. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| organizationIds | No | Apollo organization identifiers to match. | |
| excludeLocations | No | Headquarters locations to exclude, such as ireland. | |
| jobPostingTitles | No | Job titles listed in the organization's active job postings, such as sales manager. | |
| technologySlugOr | No | Only organizations that use ANY of these technologies. Apollo technology identifiers, such as salesforce or google_analytics (spaces and periods become underscores). The technologies output of the Apollo organization SKUs returns them as id. | |
| jobPostingLocations | No | Locations of the organization's active job postings, such as japan. | |
| maxLatestFundingUsd | No | Maximum amount raised in the most recent funding round, in whole USD. | |
| minLatestFundingUsd | No | Minimum amount raised in the most recent funding round, in whole USD. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| headcountGrowthMonths | No | Trailing window in months for the headcount growth filter. Takes effect only together with minHeadcountGrowthPercent or maxHeadcountGrowthPercent. | |
| lastFundingRoundDateGte | No | Only organizations whose most recent funding round is on or after this date. Format: YYYY-MM-DD. | |
| lastFundingRoundDateLte | No | Only organizations whose most recent funding round is on or before this date. Format: YYYY-MM-DD. | |
| lookalikeOrganizationIds | No | Apollo organization identifiers to use as lookalike seeds, at most five. Results are narrowed to organizations similar to the seeds, and the seeds themselves are excluded. A seed Apollo holds no lookalike data for returns no results. | |
| maxHeadcountGrowthPercent | No | Maximum organization headcount growth over headcountGrowthMonths, as a whole percentage such as 100 for 100%. | |
| minHeadcountGrowthPercent | No | Minimum organization headcount growth over headcountGrowthMonths, as a whole percentage such as 10 for 10%. Negative values are accepted. |
anyapi_post_v1_run_apollo_people_searchApollo People SearchInspect
Search people by title, seniority, name, location, employer domain or id, email status, and employer revenue, technology, hiring, and headcount growth, with normalized profile summaries. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | One-based result page. | |
| limit | No | Maximum people returned on this page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| titles | No | Job titles to match. | |
| maxJobs | No | Maximum number of active job postings at the organization. | |
| minJobs | No | Minimum number of active job postings at the organization. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | No | Keywords to match across people records. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| personName | No | Person name to match; results include people whose name contains every word. | |
| seniorities | No | Seniority levels to match. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| emailStatuses | No | Email statuses to match. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| maxRevenueUsd | No | Maximum organization annual revenue, in whole USD with no symbols. | |
| minRevenueUsd | No | Minimum organization annual revenue, in whole USD with no symbols. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| employeeRanges | No | Organization employee-count ranges in Apollo notation, such as 51,200. | |
| jobPostedAtGte | No | Only organizations with a job posted on or after this date. Format: YYYY-MM-DD. | |
| jobPostedAtLte | No | Only organizations with a job posted on or before this date. Format: YYYY-MM-DD. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| organizationIds | No | Apollo identifiers of the person's current employer. | |
| personLocations | No | Person locations to match. | |
| jobPostingTitles | No | Job titles listed in the organization's active job postings, such as sales manager. | |
| technologySlugOr | No | Only people whose current employer uses ANY of these technologies. Apollo technology identifiers, such as salesforce or google_analytics (spaces and periods become underscores). The technologies output of the Apollo organization SKUs returns them as id. | |
| technologySlugAnd | No | Only people whose current employer uses ALL of these technologies. Apollo technology identifiers, such as salesforce or google_analytics (spaces and periods become underscores). The technologies output of the Apollo organization SKUs returns them as id. | |
| technologySlugNot | No | Exclude people whose current employer uses any of these technologies. Apollo technology identifiers, such as salesforce or google_analytics (spaces and periods become underscores). The technologies output of the Apollo organization SKUs returns them as id. | |
| jobPostingLocations | No | Locations of the organization's active job postings, such as japan. | |
| organizationDomains | No | Domains of the person's current or previous employer, without www, at most 1000. | |
| includeSimilarTitles | No | Whether titles similar to the ones in titles also match. Set false for strict title matches only. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| headcountGrowthMonths | No | Trailing window in months for the headcount growth filter. Takes effect only together with minHeadcountGrowthPercent or maxHeadcountGrowthPercent. | |
| organizationLocations | No | Organization headquarters locations to match. | |
| lookalikeOrganizationIds | No | Apollo organization identifiers to use as lookalike seeds, at most five. Results are narrowed to organizations similar to the seeds, and the seeds themselves are excluded. A seed Apollo holds no lookalike data for returns no results. | |
| maxHeadcountGrowthPercent | No | Maximum organization headcount growth over headcountGrowthMonths, as a whole percentage such as 100 for 100%. | |
| minHeadcountGrowthPercent | No | Minimum organization headcount growth over headcountGrowthMonths, as a whole percentage such as 10 for 10%. Negative values are accepted. | |
| excludeOrganizationDomains | No | Exclude people whose current employer matches any of these domains. Every domain Apollo holds for that employer is excluded. |
anyapi_post_v1_run_apollo_person_enrichApollo Person EnrichmentInspect
Enrich a person by email, email hash, LinkedIn URL, Apollo person id, or name and organization with contact, role, location, and company data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| No | Work or personal email used to identify the person. | ||
| domain | No | Organization domain used with the person's name. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| fullName | No | Person full name, used with an organization identifier instead of firstName and lastName. | |
| lastName | No | Person last name, used with firstName and an organization identifier. | |
| personId | No | Apollo person identifier, such as an id returned by apollo.people_search. | |
| emailHash | No | MD5 or SHA-256 hash of the person's email, used to identify the person. | |
| firstName | No | Person first name, used with lastName and an organization identifier. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| linkedinUrl | No | LinkedIn profile URL used to identify the person. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| organizationName | No | Organization name used with the person's name. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| revealPersonalEmails | No | Whether to include personal emails. Apollo withholds them for people in GDPR regions. |
anyapi_post_v1_run_appstore_reviewsApp Store ReviewsInspect
Get App Store reviews for any iOS app by app ID, in any storefront country: ratings, titles, and review text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| appId | Yes | Numeric App Store app ID, the digits at the end of the app's store URL without the 'id' prefix (e.g. 310633997). | |
| limit | No | Maximum number of results to return (1-100, default 100). | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of reviews. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | Two-letter App Store storefront country code to read reviews from. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `helpfulVotes` or `version`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a review that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_bluesky_postBluesky PostInspect
Get a single Bluesky post by URL - text, author handle, like, reply, and repost counts as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Bluesky post URL, e.g. "https://bsky.app/profile/bsky.app/post/3l6oveex3ii2l". | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_bluesky_profileBluesky ProfileInspect
Get a Bluesky user's public profile by handle - display name, bio, follower and post counts as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Bluesky handle, e.g. "bsky.app" or "jay.bsky.team". | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_bluesky_user_postsBluesky User PostsInspect
List a Bluesky account's recent posts (text, author handle, like, reply, and repost counts) by handle as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Bluesky handle, e.g. "bsky.app" or "jay.bsky.team". | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_booking_searchBooking.com SearchInspect
Search Booking.com stays by destination and dates with optional guest and room occupancy and get hotel results (name, price, review score, location) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of hotels to return (1-20, default 20). You are billed per result returned, so a lower limit costs less. | |
| query | Yes | Destination city to search for stays in (e.g. Paris). | |
| rooms | No | Number of rooms to book (e.g. 1). | |
| adults | No | Number of adult guests (e.g. 2). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| checkIn | No | Check-in date in YYYY-MM-DD format (e.g. 2026-07-01). Defaults to tomorrow. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| checkOut | No | Check-out date in YYYY-MM-DD format (e.g. 2026-07-05). Defaults to the day after check-in. | |
| children | No | Number of child guests (e.g. 1). | |
| currency | No | Currency code for prices (e.g. EUR). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_capterra_reviewsCapterra ReviewsInspect
Pull Capterra software reviews for any product: overall and sub-ratings, pros and cons, reviewer job title, company size, and industry as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of reviews to return. The minimum is 10 because the cheapest Capterra review source will not serve a smaller page. You are billed per returned result, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| sortBy | No | Sort order for the returned reviews: newest first, most complete first, or highest or lowest rated first. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| product | Yes | Capterra product URL, for example https://www.capterra.com/p/135003/Slack/. Capterra identifies a product by both its numeric id and its slug, so the full URL is required. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `ownerResponse`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a review that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_chatgpt_searchChatGPT SearchInspect
Ask ChatGPT a web-grounded question and receive an answer with source citations. ChatGPT composes each answer per request, so the same prompt returns different wording and a different source set. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| prompt | Yes | Question or research prompt for ChatGPT to answer using web search. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | ISO-3166 alpha-2 country to ask from, e.g. US, GB, DE. ChatGPT localizes both the pages it retrieves and the answer it writes, so this is the difference between what a US buyer and a UK buyer are told. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| webSearch | No | Whether to insist ChatGPT browses the web. force instructs it to search and is the default; auto lets ChatGPT decide, which is cheaper and answers from memory roughly half the time. Check webSearchTriggered for what actually happened - an answer written without a search is not web-grounded. | |
| requireAds | No | Serve only from a source that can return sponsored placements shown with the answer. One source currently qualifies, so the request cannot fall back when it is unavailable. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `cited` or `ads`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a result that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| requirePlaces | No | Serve only from a source that can return places shown with the answer. Leaving this off still returns places whenever the source that answered can. Turning it on selects the single source that guarantees them, which costs more and has nothing to fall back to if it is unavailable. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| requireEntities | No | Serve only from a source that can return brands and other named entities recognized in the answer. One source currently qualifies, so the request cannot fall back when it is unavailable. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| requireShoppingCards | No | Serve only from a source that can return shopping cards shown with the answer. Leaving this off still returns shopping cards whenever the source that answered can. Turning it on selects the single source that guarantees them, which costs more and has nothing to fall back to if it is unavailable. |
anyapi_post_v1_run_coinmarketcap_listingsCoinMarketCap ListingsInspect
Get the current top cryptocurrencies from CoinMarketCap (rank, price, market cap, volume, and 24h change) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-25, default 25). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_enrichment_lushaCompany Enrichment - LushaInspect
Enrich one company into firmographics, industry classification, headcount, revenue band and social profiles from a domain, a company name, or a Lusha company id. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| domain | No | Company domain, e.g. posthog.com. Send the bare domain, without a scheme or www. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | No | Company name to look up when you have no domain. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| companyId | No | Lusha's own company identifier, as returned by this SKU's companyId output. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_enrichment_peopledatalabsCompany Enrichment - People Data LabsInspect
Enrich one company into firmographics, funding history, NAICS and SIC classification, and People Data Labs' headcount growth, tenure and churn series from a domain or a company name. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| name | No | Company name, for when you have no domain. | |
| domain | No | Company website domain, e.g. posthog.com. The strongest identifier. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| required | No | People Data Labs boolean expression over top-level fields that a match must satisfy, e.g. website and industry. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| titlecase | No | Return text in title case instead of People Data Labs' lowercase default. | |
| dataInclude | No | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; it does not reduce what the call costs. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| minLikelihood | No | Minimum People Data Labs likelihood score a match must reach to count as found. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeIfMatched | No | Report which of the sent identifiers actually matched. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_enrichment_prospeoCompany Enrichment - ProspeoInspect
Enrich one company into firmographics, funding history, technology stack, open roles and headquarters contact details from a website, a company name, or a LinkedIn page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| companyId | No | Prospeo's own company identifier, as returned by this SKU's companyId output. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyName | No | Company name, for when you have no domain. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| companyWebsite | No | Company domain, e.g. stripe.com. The most reliable identifier. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyLinkedinUrl | No | Company LinkedIn page URL. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_identify_crustdata_v3Company Identify - Crustdata v3Inspect
Resolve one company from its domain, LinkedIn company page, Crustdata company id, or name to its Crustdata id, primary domain, LinkedIn page, and basic profile. Identify a company for $1 per 1,000 requests before paying to enrich it. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| companyId | No | Crustdata company id, as returned in companyId by this or another Crustdata v3 endpoint. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| exactMatch | No | Require an exact match on the identifier instead of letting Crustdata decide. Leave unset for automatic matching. | |
| companyName | No | Full company name, including any legal suffix. A name match is a best guess; confirm it against the returned domain or LinkedIn page before relying on it. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | No | Company website domain without a scheme or path, e.g. stripe.com. Send exactly one of companyDomain, companyLinkedinUrl, companyId, or companyName. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyLinkedinUrl | No | LinkedIn company page URL, e.g. https://www.linkedin.com/company/stripe. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_search_ai_arkCompany Search - AI ArkInspect
Search companies by name, lookalike domains, account filters, and saved-list filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| name | No | Company-name search text. | |
| page | No | Zero-based result page. | |
| size | No | Maximum companies to return on this page. | |
| lists | No | AI Ark saved-list filter expression. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| account | No | AI Ark account filter expression. Nested generic any/all filter objects are accepted as documented by the source and are not further constrained. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| lookalikeDomains | No | Domains whose company characteristics should guide the search. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_search_fullenrichCompany Search - FullEnrichInspect
Build an account list from FullEnrich by name, domain, industry, specialty, ownership type, headcount, founding year and headquarters, with full firmographics and every office on each row. Billed per company returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Rows to return on this page, up to FullEnrich's maximum of 100. Every row returned is billed. | |
| names | No | Filter by company name. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| types | No | Filter by ownership type, e.g. Public Company, Privately Held, Nonprofit. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| cursor | No | Cursor from a previous response's nextCursor. Works at any depth, including past the 10000 offset ceiling. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Rows to skip. FullEnrich caps offset at 10000; past that, page with cursor. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| domains | No | Filter by company domain, e.g. stripe.com. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | No | Filter by words in the company description. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyIds | No | Filter by FullEnrich company id. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| headcounts | No | Filter by employee headcount band. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| industries | No | Filter by company industry, e.g. Software Development. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| specialties | No | Filter by company specialty. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| foundedYears | No | Filter by founding year. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| linkedinUrls | No | Filter by company LinkedIn URL. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| headquartersLocations | No | Filter by headquarters city, region or country. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
anyapi_post_v1_run_company_search_peopledatalabsCompany Search - People Data LabsInspect
Search People Data Labs' company dataset with SQL or an Elasticsearch query and get the full firmographic record back, including funding history and the headcount growth, tenure and churn series. Billed per company returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sql | No | People Data Labs SQL, in the form SELECT * FROM company WHERE ... . String literals take single quotes, only SELECT * is supported, and field names must be real People Data Labs company fields including nested subfields such as location.country. Do not include a LIMIT clause; People Data Labs rejects it. Use limit instead. Send this or query, never both. | |
| limit | No | Maximum companies to return. Every company returned is billed, so start at 1 to check a query and read total before asking for more. | |
| query | No | Elasticsearch-style query over the People Data Labs company dataset, e.g. {"bool": {"must": [{"term": {"website": "posthog.com"}}]}}. Send this or sql, never both. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| titlecase | No | Return text in title case instead of People Data Labs' lowercase default. | |
| dataInclude | No | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; billing still follows companies returned. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_search_prospeoCompany Search - ProspeoInspect
Build an account list from Prospeo by industry, headcount, revenue, location, technology, funding and hiring activity. One flat price per page of 25. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Page number, one-based. Prospeo returns 25 results per page and charges one flat price per page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | No | Filter by company names or websites, e.g. {"names": {"include": ["Stripe"]}, "websites": {"include": ["stripe.com"]}}. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companySics | No | Filter by SIC codes. | |
| companyType | No | Filter by ownership type. | |
| companyNaics | No | Filter by NAICS codes. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| companyFounded | No | Filter by founding year range. | |
| companyFunding | No | Filter by funding stage or amount raised. | |
| companyRevenue | No | Filter by revenue range. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyIndustry | No | Filter by company industry. | |
| companyKeywords | No | Filter by keywords found in company data. | |
| companyAttributes | No | Filter by company characteristics, e.g. B2B, has pricing, has a free trial. | |
| companyTechnology | No | Filter by technologies the company uses. | |
| companyEmailProvider | No | Filter by the company's email MX provider. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| companyHeadcountRange | No | Filter by Prospeo's predefined employee count bands. | |
| companyLocationSearch | No | Filter by company headquarters location. | |
| companyHeadcountCustom | No | Filter by a custom employee count range. | |
| companyHeadcountGrowth | No | Filter by headcount growth. | |
| companyJobPostingQuantity | No | Filter by how many roles the company has open. | |
| companyJobPostingHiringFor | No | Filter by the roles the company is currently hiring for. | |
| companyHeadcountByDepartment | No | Filter by headcount within a department. |
anyapi_post_v1_run_company_search_quickenrichCompany Search - QuickEnrichInspect
Find companies by name, domain, industry, headcount, revenue, services, or location, and get back their site, LinkedIn, and contact details. Billed per company returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| city | No | Filter on city name. | |
| page | No | One-based result page. | |
| limit | No | Maximum companies to return on this page. Every company returned is billed. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | Filter on ISO 3166-1 alpha-2 country code, e.g. "US". | |
| revenue | No | Filter on revenue band. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| industry | No | Filter on industry label. Values must match the QuickEnrich industry vocabulary exactly, e.g. "IT Services and IT Consulting". | |
| services | No | Filter on the services a company lists. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyName | No | Filter on company name. | |
| linkedinBio | No | Filter on words found in the company LinkedIn bio. | |
| homePageText | No | Filter on words found in the company home page text. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | No | Filter on company website domain. Include only; exclude is rejected upstream. | |
| employeeCount | No | Filter on headcount band. Note these bands differ from the employeeCount string returned on a result. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeFullText | No | Return the full home page text on each company instead of a snippet. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_company_search_theirstackCompany Search - TheirStackInspect
Build an account list from TheirStack by the technologies, keywords and buying-intent topics a company mentions in its job posts, plus headcount, revenue, funding, industry and location. Billed per company returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Page number. Required when using page-based pagination. | |
| limit | No | Rows to return on this page, up to TheirStack's maximum of 500. Every row returned is billed. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Number of results to skip. Required for offset-based pagination. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| orderBy | No | List of column objects. You can pass several columns to order by, in order of priority. Only `field` is required, `desc` is True by default | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| industryOr | No | Names of industries, case-insensitive. Results will only include companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_or field instead. | |
| jobFilters | No | ||
| companyIdOr | No | Only return companies that match these IDs exactly. This filter acts as an OR filter, so if you pass more than one company ID, it will return companies that match any of the IDs. | |
| companyType | No | Filter by company type. | |
| industryNot | No | Names of industries, case-insensitive. Results will exclude companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_not field instead. | |
| techFilters | No | Filter by technologies and buying intent topics detected for the company | |
| industryIdOr | No | Industry codes. You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyNameOr | No | Only return companies that match these names exactly, case-sensitively. This filter acts as an OR filter, so if you pass more than one company name, it will return companies that match any of the names. | |
| companyTagsOr | No | Return companies that match any of these keywords | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| industryIdNot | No | Industry ids to exclude.You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries | |
| keywordSlugOr | No | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| maxFundingUsd | No | Maximum company funding, in USD | |
| maxRevenueUsd | No | Maximum company revenue, in USD | |
| minFundingUsd | No | Minimum company funding, in USD | |
| minRevenueUsd | No | Minimum company revenue, in USD | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| companyNameNot | No | Only return companies that don't match these names exactly, case-sensitively. | |
| fundingStageOr | No | Funding stages of companies returned. Possible values: ['angel', 'convertible_note', 'debt_financing', 'equity_crowdfunding', 'other', 'private_equity', 'seed', 'series_a', 'series_b', 'series_c', 'series_d', 'series_e', 'series_f', 'series_g', 'series_h', 'venture_round_not_specified', 'series_i', 'series_j', 'undisclosed', 'series_unknown', 'pre_seed', 'post_ipo_secondary', 'post_ipo_equity', 'post_ipo_debt', 'non_equity_assistance', 'late_vc', 'initial_coin_offering', 'growth_equity_vc', 'grant', 'early_vc', 'corporate_round', 'secondary_market', 'product_crowdfunding'] | |
| keywordSlugAnd | No | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| keywordSlugNot | No | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyDomainOr | No | Only return companies that match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). This filter acts as an OR filter, so if you pass more than one company domain, it will return companies that match any of the domains. | |
| companyListIdOr | No | Return companies that belong to any of the company lists passed here | |
| onlyYcCompanies | No | Only return YC companies | |
| companyDomainNot | No | Only return companies that don't match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). | |
| companyListIdNot | No | Return companies that don't belong to any of the company lists passed here | |
| maxEmployeeCount | No | Maximum number of employees in a company | |
| minEmployeeCount | No | Minimum number of employees in a company | |
| propertyExistsOr | No | Return companies that have any of these fields not null. For example, if you pass ['domain', 'linkedin_url'], it will return companies that have a domain OR a linkedin_url set. | |
| technologySlugOr | No | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| propertyExistsAnd | No | Return companies that have all of these fields not null. For example, if you pass ['domain', 'linkedin_url'], it will return companies that have both domain AND linkedin_url set. | |
| technologySlugAnd | No | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| technologySlugNot | No | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| companyInvestorsOr | No | Investors of the company | |
| includeTotalResults | No | When enabled, calculates and returns `total_results` and `total_companies` fields in the response. WARNING: This significantly slows down responses as it requires reading the entire dataset. Recommended usage: enable only for the initial request to get totals, then disable for subsequent pagination requests. | |
| companyCountryCodeOr | No | Return companies whose HQ country code is any of the ones passed here, case sensitive. Pass ISO2 country codes. | |
| companyKeywordSlugOr | No | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| companyLinkedinUrlOr | No | Return companies whose LinkedIn URL matches any of the slugs passed here. Can also pass full LinkedIn company URLs. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| companyCountryCodeNot | No | Return companies whose HQ country code is not any of the ones passed here, case sensitive. Pass ISO2 country codes. | |
| companyKeywordSlugAnd | No | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| companyKeywordSlugNot | No | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| expandTechnologySlugs | No | Specify technology slugs to include detailed technology usage information for each company. The response will include a 'technologies_found' field containing metrics like confidence score, ranking, and job count for each specified technology. Note: If a technology is not listed for a company, it means that company does not use that technology. This feature is useful for enriching company data with their technology stack details. | |
| maxEmployeeCountOrNull | No | Maximum number of employees in a company. If we don't have company size information, we will return it as well. | |
| minEmployeeCountOrNull | No | Minimum number of employees in a company. If we don't have company size information, we will return it as well. | |
| companyTechnologySlugOr | No | Will return jobs from companies that that have mentioned any of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_or instead. | |
| lastFundingRoundDateGte | No | Only return companies whose last funding round date is after or on this date. Format: 'YYYY-MM-DD' | |
| lastFundingRoundDateLte | No | Only return companies whose last funding round date is before or on this date. Format: 'YYYY-MM-DD' | |
| companyLinkedinUrlExists | No | (Use `property_exists_or / property_exists_and` instead) Only return companies with a LinkedIn URL | |
| companyLocationPatternOr | No | Return companies whose city matches any of the patterns passed here. Case insensitive. For example, if you pass 'san francisco', it will return companies whose city is 'San Francisco', 'San Francisco Bay Area', etc. | |
| companyTechnologySlugAnd | No | Will return jobs from companies that that have mentioned all of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_and instead. | |
| companyTechnologySlugNot | No | Will return jobs from companies that that haven't mentioned any of these technologies in their jobs. Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_not instead. | |
| companyNamePartialMatchOr | No | Company names. Will return companies whose name contain any of the the substrings passed here, case-insensitively. For example, if you pass "google", it will return "Google", "Google LLC", "Google Inc", etc. | |
| companyNamePartialMatchNot | No | Company names. Will return companies whose name doesn't contain any of the the substrings passed here, case-insensitively. For example, if you pass 'google', it will exclude 'Google', 'Google LLC', 'Google Inc', etc. | |
| companyDescriptionPatternOr | No | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. | |
| companyDescriptionPatternNot | No | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. | |
| companyNameCaseInsensitiveOr | No | Only return companies that match these names exactly, case-insensitively. | |
| companyInvestorsPartialMatchOr | No | Investors of the company. Will return companies for which any of their investors contains any of the substrings passed here. For example, if you pass 'andree', all funds that match it (like 'Andreessen Horowitz', 'Andreessen Horowitz LLC', etc). | |
| companyDescriptionPatternAccentInsensitive | No | Set to True to make company description searches accent insensitive. For example, "á" will match "a" as well. |
anyapi_post_v1_run_congress_tradesCongress Stock TradesInspect
Get US Congress members' financial disclosures and stock trades (member, ticker, transaction type, amount range, and dates), filterable by member, ticker, or date range. Results come newest filing first (by reportedUtc, not tradedUtc), so a recent filing can list trades made years earlier. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-25, default 25). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| ticker | No | Filter to transactions involving this stock ticker symbol (e.g. NVDA). | |
| endDate | No | Latest transaction date to include, inclusive, in YYYY-MM-DD format (e.g. 2026-06-01). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | No | Filter by the congressional member's last name, case-insensitive partial match (e.g. Pelosi). | |
| firstName | No | Filter by the congressional member's first name, case-insensitive partial match (e.g. Nancy). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Earliest transaction date to include, inclusive, in YYYY-MM-DD format (e.g. 2026-01-01). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_contact_enrichment_crustdata_v3Contact Enrichment - Crustdata v3Inspect
Find one person's business emails, personal emails, and phone numbers from a LinkedIn profile URL or a business email, with a deliverability status on every email. Billed only when the person is found. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| No | The person's business email address. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| linkedinUrl | No | LinkedIn profile URL, e.g. https://www.linkedin.com/in/satyanadella. Send exactly one of linkedinUrl or email. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_douyin_profileDouyin ProfileInspect
Look up a public Douyin profile by sec_user_id and return normalized profile statistics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| secUserId | Yes | Douyin sec_user_id for the public account. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_douyin_search_videosDouyin Video SearchInspect
Search public Douyin videos by keyword with sorting, time, duration, and content filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| body | Yes | Search public Douyin videos by keyword with sorting, time, duration, and content filters. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. |
anyapi_post_v1_run_douyin_user_postsDouyin User PostsInspect
List public posts from a Douyin user with normalized engagement data and pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Post order: newest, most-popular. | |
| limit | No | Requested page size. Values up to 20 are recommended. | |
| cursor | No | Pagination cursor from the previous response; omit for the first page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| secUserId | Yes | Douyin sec_user_id for the public account. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_douyin_videoDouyin VideoInspect
Fetch a public Douyin video by share URL with normalized author and engagement data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Public Douyin video share URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_douyin_video_commentsDouyin Video CommentsInspect
List public comments on a Douyin video with author and engagement data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from the previous response; omit for the first page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| videoId | Yes | Douyin aweme_id for the video. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_ebay_producteBay ProductInspect
Fetch one eBay listing by URL and get the full offer record: price, condition, shipping, item location, seller feedback, quantity, watchers, and live auction state (bid count and end time). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full eBay listing URL (e.g. https://www.ebay.com/itm/133576802017). The marketplace is taken from the host, so an ebay.co.uk or ebay.de URL returns that site's listing and currency. Item ids come back on every row of ebay.search and ebay.sold_listings. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_ebay_product_fulleBay Product FullInspect
Fetch one eBay listing by URL with the complete item-specifics table the seller filled in (MPN, model, capacity, compatibility and every other per-category attribute), the seller's full description, every listing image, and the seller's feedback record. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full eBay listing URL (e.g. https://www.ebay.com/itm/133576802017). Works on ended and sold listings as well as live ones, so it composes with ebay.sold_listings: pull the comps cheaply, then enrich the few you care about. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_ebay_searcheBay SearchInspect
Search eBay active listings by keyword with optional price-range, item-condition, listing-type, and sort filters and get title, price, condition, shipping, and seller in one normalized response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Result sort order; omit for eBay's Best Match (e.g. price_low sorts by lowest price plus shipping first). | |
| limit | No | Maximum number of results to return (1 to 25, default 25). | |
| query | Yes | Search keywords, e.g. "nintendo switch" or "vintage levis 501". | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| maxPrice | No | Optional maximum item price in USD. | |
| minPrice | No | Optional minimum item price in USD. | |
| condition | No | Filter by one or more item conditions; omit for all conditions (e.g. ["new", "open_box"]). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| listingType | No | Restrict to a listing format; omit or use all for both (e.g. buy_it_now for fixed-price only). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `sellerName`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a listing that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_ebay_sold_listingseBay Sold ListingsInspect
Retrieve recently sold eBay listings for any keyword with optional price-range, condition, category, sold-date, and sort filters, page by page (sold price, sale date, condition, seller, item details); ideal for pricing research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | 1-based results page. Use with hasMore in the output to paginate, and keep query, filters, and limit the same while walking pages, because limit sets the page size. | |
| site | No | eBay country site to search. Sold-listing coverage is currently US only. | |
| sort | No | Result sort order; omitted means ended_recently (e.g. price_high sorts by highest sold price plus shipping first). | |
| limit | No | Maximum number of results to return (1-60, default 25). | |
| query | Yes | Search keyword for sold items (e.g. iphone 13 pro). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| seller | No | Not supported by the current sources: a request that sets it is refused without charge. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| endDate | No | Only return listings sold on or before this date, inclusive, in YYYY-MM-DD format (e.g. 2026-09-15). This bound is applied to each page after it is fetched, so a page can hold fewer than limit listings, or none, while hasMore is still true: keep requesting the next page until hasMore is false. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| maxPrice | No | Optional maximum sold price in the site currency (e.g. 500). | |
| minPrice | No | Optional minimum sold price in the site currency (e.g. 200). | |
| condition | No | Item condition filter (e.g. used). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Only return listings sold on or after this date, inclusive, in YYYY-MM-DD format (e.g. 2026-09-01). | |
| categoryId | No | Optional numeric eBay category id to search within (e.g. 9355 for Cell Phones & Smartphones, 9394 for Cell Phone Accessories). | |
| listingType | No | Restrict to a listing format; omit or use all for both (e.g. auction for auction sales only). | |
| freeShipping | No | Not supported by the current sources: only false (no filter) is accepted; true is refused without charge. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| returnsAccepted | No | Not supported by the current sources: only false (no filter) is accepted; true is refused without charge. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_ebay_sold_listings_thineBay Sold Listings (Basic)Inspect
Retrieve recently sold eBay listings for any keyword with the sold price, sale date, condition, format, bids, and whether a Best Offer was accepted, without seller details; the lighter sibling of eBay Sold Listings for price comps. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| site | No | eBay country site to search. Sold-listing coverage is currently US only. | |
| sort | No | Result sort order; omitted means ended_recently (e.g. price_high sorts by highest sold price plus shipping first). | |
| limit | No | Maximum number of results to return (1-60, default 25). | |
| query | Yes | Search keyword for sold items (e.g. iphone 13 pro). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| maxPrice | No | Optional maximum sold price in the site currency (e.g. 500). | |
| minPrice | No | Optional minimum sold price in the site currency (e.g. 200). | |
| condition | No | Item condition filter (e.g. used). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| listingType | No | Restrict to a listing format; omit or use all for both (e.g. auction for auction sales only). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_findEmail FinderInspect
Find a person's work email address from their name and company domain. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| person | No | The person to find an email for, e.g. {"firstName": "Jane", "surname": "Doe", "domain": "acme.com"} (domain also accepts a company name). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_finding_dropleadsEmail Finding - DropLeadsInspect
Find a professional email from a person's name and company domain or company name. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | Yes | Person's last name. | |
| firstName | Yes | Person's first name. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyName | No | Company name when the domain is unavailable. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | No | Company domain without a path. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_finding_hunter_countEmail Finding - Hunter Email CountInspect
Count how many contacts a company domain has, split by personal and generic mailboxes and broken down by department and seniority. Scope a domain for $1 per 1,000 requests before paying per contact. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| type | No | Count only personal mailboxes belonging to a named person, or only generic ones such as info@ and support@. | |
| domain | Yes | Company domain without a scheme or path, e.g. stripe.com. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_finding_hunter_domainEmail Finding - Hunter Domain SearchInspect
Find named contacts and their work email addresses at a company domain, filtered by job title, seniority or department. Priced per returned contact, so limit is the cost control. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| type | No | Restrict to personal mailboxes belonging to a named person, or to generic ones such as info@ and support@. | |
| limit | No | Maximum contacts to return in this response. Every returned contact is billed, so this is the cost control. | |
| domain | Yes | Company domain without a scheme or path, e.g. stripe.com. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Number of contacts to skip before this page begins. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| jobTitle | No | One job-title keyword to match, e.g. editor. A single keyword only: a comma-separated list is not supported and only its last entry would apply. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| seniority | No | Restrict to one seniority level. | |
| department | No | Restrict to one department. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requiredField | No | Only return contacts that carry this field. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_finding_quickenrichEmail Finding - QuickEnrichInspect
Find a work email from a LinkedIn profile, or from a company domain plus a name. Coverage is strongest for small and local businesses and thin for large technology employers. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | No | Person's last name. | |
| firstName | No | Person's first name. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| linkedinUrl | No | LinkedIn profile URL. Provide this, or companyDomain with firstName and lastName. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | No | Company website domain, normalized upstream (example.com or https://example.com both work). | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_finding_zerobounceEmail Finding - ZeroBounceInspect
Find a person's work email at a company domain from their name, with ZeroBounce's confidence in the guess. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| domain | Yes | Company domain to search, e.g. hubspot.com. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | No | Last name of the person to find. | |
| firstName | No | First name of the person to find. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| middleName | No | Middle name, when the company's address format uses one. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_finding_zerobounce_domainEmail Pattern - ZeroBounceInspect
Read the email address format a company domain uses, with every alternative format ZeroBounce has seen and how confident it is in each. Use it to build addresses for a whole account at once. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| domain | Yes | Company domain to inspect, e.g. hubspot.com. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_verification_allegrowEmail Verification - AllegrowInspect
Validate an email address and return its deliverability verdict and mailbox signals. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| Yes | Email address to validate. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_verification_icypeasEmail Verification - IcypeasInspect
Verify an email address. A valid negative verdict is a successful, billable result. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| Yes | |||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_verification_zerobounceEmail Verification - ZeroBounceInspect
Validate one email address against ZeroBounce, with the deliverability verdict, why it was reached, the mailbox provider, and any owner details ZeroBounce holds. A negative verdict is a successful, billable result. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| Yes | Email address to validate. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| ipAddress | No | IP address the address signed up from. ZeroBounce uses it to add the geographic fields to the answer. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_verification_zerobounce_activityEmail Activity - ZeroBounceInspect
Check whether an email address has shown recent activity across ZeroBounce's engagement network before you re-engage it. A no-activity answer is a successful, billable result. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| Yes | Email address to check for activity. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_email_verifyEmail VerifierInspect
Verify an email address for deliverability: a status verdict (good, risky, or bad) with domain, mailbox, catch-all, disposable, and role signals plus a confidence score. Malformed addresses are rejected by the input schema with no charge; every syntactically valid address returns a billed verdict, including undeliverable ones. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| Yes | |||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `reason`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a result that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_ad_detailsFacebook Ad DetailsInspect
Look up a single Meta Ad Library ad by ID or URL and get the advertiser, creative text, call-to-action, platforms, and run dates as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Meta Ad Library ad ID (e.g. "702369045530963"). Provide either id or url. | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Meta Ad Library ad URL (e.g. "https://www.facebook.com/ads/library?id=1185617869915074"). Provide either id or url. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_ad_details_fullFacebook Ad Creative DetailsInspect
Pull one Meta Ad Library ad with its creative: every carousel variant, image and video URL, headline, body, and call to action. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Meta Ad Library ad ID - the numeric id in an Ad Library URL (e.g. "962050096457659" from https://www.facebook.com/ads/library/?id=962050096457659). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_ads_searchFacebook Ad SearchInspect
Search the Meta Ad Library by keyword and get matching ads (advertiser, creative text, CTA, platforms, and run dates) with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Keyword to search the Meta Ad Library for (e.g. "protein powder"). | |
| adType | No | Restrict to all ads (default) or only political and issue ads. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| sortBy | No | Sort order: impressions (highest first, the default) or recent (most recent). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| status | No | Ad status filter. | |
| country | No | Two-letter country code to scope results. Omit for all countries. | |
| endDate | No | Filter to ads with impressions on or before this date, in YYYY-MM-DD format. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| mediaType | No | Creative media type filter. | |
| startDate | No | Filter to ads with impressions on or after this date, in YYYY-MM-DD format. | |
| searchType | No | Match mode for the query: loose keyword match (keyword_unordered, the default) or exact phrase (keyword_exact_phrase). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `totalResults`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on an ad that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_ad_transcriptFacebook Ad TranscriptInspect
Get the spoken-word transcript of a Meta Ad Library video ad by ad ID or URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Meta Ad Library ad ID (e.g. "1020359190509080"). Provide either id or url. | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Meta Ad Library ad URL (e.g. "https://www.facebook.com/ads/library?id=1020359190509080"). Provide either id or url. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_comment_repliesFacebook Comment RepliesInspect
List the replies to a Facebook post comment (text, author, reactions, and timestamps) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| feedbackId | Yes | The feedback_id of the comment (not the comment id). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| expansionToken | Yes | The expansion_token of the comment, from the post comments endpoint. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_event_detailsFacebook Event DetailsInspect
Fetch full details for a single Facebook event by ID or URL (name, schedule, venue, hosts, and attendance) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The event's numeric identifier. | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | The event's Facebook URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_eventsFacebook EventsInspect
List public Facebook events for a city or place by its events-page URL (event name, date, venue, and attendance) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | URL of a city's or place's Facebook Events page (e.g. https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547). | |
| time | No | Timeframe filter for the returned events. Defaults to all time. | |
| cursor | No | Pagination cursor from a previous response to fetch the next page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_events_searchFacebook Events SearchInspect
Search public Facebook events by keyword and get structured event records (name, schedule, venue, pricing, and attendance) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The query to search events for. | |
| cursor | No | Pagination cursor from a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_followersFacebook FollowersInspect
List the public followers (or accounts followed) of any Facebook page or profile URL as normalized JSON records. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Facebook page or profile URL to list follows for (e.g. https://www.facebook.com/nasa). | |
| limit | No | Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| followType | No | Which relation to fetch: 'follower' or 'following' (e.g. follower). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_marketplaceFacebook MarketplaceInspect
Search Facebook Marketplace listings by keyword near a location, filter by price, condition, delivery, recency, and availability, and get title, price, location, and image as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| lat | Yes | Latitude of the search location (e.g. '30.2677'). | |
| lng | Yes | Longitude of the search location (e.g. '-97.7475'). | |
| sort | No | Sort order for the returned listings (e.g. price_ascend). | |
| query | Yes | Search keyword for Marketplace listings (e.g. 'bike'). | |
| cursor | No | Pagination cursor from a previous response to fetch the next page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| priceMax | No | Maximum listing price in whole currency units, e.g. 500 for $500. Facebook may mix in a few suggested listings outside the range. | |
| priceMin | No | Minimum listing price in whole currency units, e.g. 100 for $100. Facebook may mix in a few suggested listings outside the range. | |
| condition | No | Only return listings in this condition (e.g. used_good). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| dateListed | No | Only return listings posted within this window (e.g. last_7_days). | |
| availability | No | Filter by availability: available (default), sold, or all (e.g. sold). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| deliveryMethod | No | Only return listings offering this delivery method (e.g. shipping). | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_marketplace_location_searchFacebook Marketplace Location SearchInspect
Resolve a place name to Facebook Marketplace locations with coordinates and metadata as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Location search query (e.g. a city name). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_page_contactFacebook Page Contact InfoInspect
Look up a Facebook Page's public contact details (email, phone, website, and address) by page URL or ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | Yes | Facebook Page URL or page ID to look up (e.g. https://www.facebook.com/nasa). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Locale code for the returned data (e.g. en-US). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_page_lookupFacebook Page LookupInspect
Look up Facebook Pages and profiles by name with Facebook's own quick search. A name lookup that returns basic identity fields only: name, URL, profile image, Facebook id, and verified status. Matches can include personal profiles as well as Pages. For full Page details (category, followers, phone, website), use facebook.search_pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of matches to return (1-7, default 7). Facebook's quick search answers a name with at most 7 matches. | |
| query | Yes | Name to look up, as you would type it into Facebook's search box (e.g. NASA or plumber chicago). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_photosFacebook Page PhotosInspect
Fetch recent photos posted by any public Facebook page or profile (image URLs, captions, and dimensions) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | URL of the public Facebook page or profile to fetch photos from (e.g. https://www.facebook.com/Spurs). | |
| cursor | No | Pagination cursor from a previous response to fetch the next page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `imageWidth`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a photo that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_postFacebook PostInspect
Fetch a single Facebook post by URL with its text and engagement counts (likes, comments, shares, views). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full Facebook post URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `videoId` or `views`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_post_transcriptFacebook Post TranscriptInspect
Get the spoken-word transcript of any public Facebook video post by URL as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The Facebook post or video URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_profile_eventsFacebook Page EventsInspect
List upcoming and past events hosted by any public Facebook page by URL (name, schedule, venue, and host) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The Facebook page link whose events to list, e.g. https://www.facebook.com/brickyardoldtown. Accepted: facebook.com/<name>, /p/<name>-<id>, /pages/<name>/<id>, /pg/<name>, /people/<name>/<id> and profile.php?id=<id>, on facebook.com or fb.com with or without www, m, mbasic, web, business or a language subdomain. Anything after the page, such as a tab, is fine: only the page is read. Any other Facebook link, such as a single event, group, share link, reel, video, hashtag, search or login page, is refused as invalid input, with no charge; facebook.event_details reads one event. | |
| cursor | No | Pagination cursor from a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_search_companiesFacebook Company SearchInspect
Search the Meta Ad Library for advertisers by keyword and get matching pages: page ID, category, verification, follower counts, and linked Instagram. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Keyword to search advertiser pages for (e.g. "nike"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_search_pagesFacebook Page SearchInspect
Search Facebook Pages by keyword, optionally narrowed to a location, and get structured page profiles (name, category, followers, contact details). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-10, default 10). You are billed per result returned, so a lower limit costs less. | |
| query | Yes | Keyword to search Facebook Pages for (e.g. 'coffee roasters'). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Optional free-text location to narrow the search: a city, province, or country (e.g. 'Berlin'). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_facebook_search_postsFacebook Post SearchInspect
Search public Facebook posts by keyword, optionally filtered by location, and get structured post records (text, author, engagement). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| query | Yes | Keyword or phrase to search Facebook posts for (e.g. 'product launch'). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| endDate | No | Only return posts published on or before this date, format YYYY-MM-DD (e.g. 2024-12-31). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Optional place name; include both city and country for best matches (e.g. 'Paris, France'). Uses Facebook's place filter, which favors posts tagged at that place rather than every post by people who live there, and can still return some posts from elsewhere. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Only return posts published on or after this date, format YYYY-MM-DD (e.g. 2024-01-01). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_fiverr_searchFiverr Gig SearchInspect
Extract Fiverr gig listings from any search or category URL: titles, sellers, ratings, and pricing as structured JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Fiverr search or category page URL to extract gigs from. | |
| limit | No | Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_gemini_searchGemini SearchInspect
Ask Gemini a web-grounded question and receive an answer with source citations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| prompt | Yes | Question or research prompt for Gemini to answer using web search. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_repositoryGitHub RepositoryInspect
Fetch a GitHub repository's metadata by URL (stars, forks, language, topics, license, and timestamps). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | GitHub repository URL (e.g. https://github.com/facebook/react). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_trending_developersGitHub Trending DevelopersInspect
List trending GitHub developers (rank, username, name, avatar, and their most popular repository), optionally filtered by programming language and time range. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| since | No | Trending range: daily, weekly, or monthly (defaults to daily). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Programming language to filter trending developers (e.g. javascript, python, go). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_trending_repositoriesGitHub Trending RepositoriesInspect
List GitHub Trending repositories (rank, stars, stars gained today, language, and description), filterable by language and time window. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| since | No | Trending window. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Filter by programming language (e.g. "go", "typescript"). Omit for all languages. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_userGitHub UserInspect
Fetch a GitHub user's public profile by handle (name, bio, company, location, followers, and repo counts). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | GitHub username. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_user_activityGitHub User ActivityInspect
List a GitHub user's public contribution activity by handle (grouped monthly summaries of commits, pull requests, and issues with repository links) for a given year. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| year | No | Year of contribution activity to return (defaults to the current year). | |
| cursor | No | Pagination cursor from a previous response (pages backward by month). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | GitHub username. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_user_contributionsGitHub User ContributionsInspect
Fetch a GitHub user's contribution graph for a year (total contributions plus per-day counts and heatmap intensity). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| year | No | Calendar year of the contribution graph. Defaults to the current year. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | GitHub username. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_user_followersGitHub User FollowersInspect
List a GitHub user's followers by handle (each follower's login, type, avatar, and profile URL) with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response (page number, defaults to 1). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | GitHub username. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_user_followingGitHub User FollowingInspect
List the GitHub users a given user follows by handle (each account's login, type, avatar, and profile URL) with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response (page number, defaults to 1). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | GitHub username. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_user_pull_requestsGitHub User Pull RequestsInspect
List a GitHub user's public pull requests by handle (title, repository, state, creation date, and URL) with optional date filtering and pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| since | No | Only include pull requests created on or after this date (YYYY-MM-DD). | |
| until | No | Only include pull requests created on or before this date (YYYY-MM-DD). | |
| cursor | No | Pagination cursor from a previous response (page number, defaults to 1). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | GitHub username. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_github_user_repositoriesGitHub User RepositoriesInspect
List a GitHub user's public repositories (name, description, language, stars, and forks) with sorting and cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Repository ordering. | |
| type | No | Which repositories to include: owner (default), all, or member. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it back to fetch the next page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | GitHub username. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| direction | No | Sort direction, ascending or descending, paired with sort. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_ads_ad_detailsGoogle Ads Ad DetailsInspect
Look up a single Google Ads Transparency Center creative by URL and get its format, run dates, impression range, regions, and creative variations as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Google Ads Transparency Center creative URL (e.g. "https://adstransparency.google.com/advertiser/AR.../creative/CR..."). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_ads_advertiser_searchGoogle Ads Advertiser SearchInspect
Search the Google Ads Transparency Center for advertisers by keyword and get matching advertiser IDs, regions, and estimated ad counts as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Advertiser name or keyword to search for (e.g. "lululemon"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | Two-letter country code to scope results (e.g. "AU", "CA"). Defaults to US. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_ads_company_adsGoogle Ads Company AdsInspect
List the ads a company is running from the Google Ads Transparency Center by domain or advertiser ID (creative ID, format, ad URL, and first/last shown dates) with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| topic | No | Search topic. "political" requires a region. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. | |
| domain | No | Company domain (e.g. "lululemon.com"). Provide either domain or advertiserId. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| format | No | Ad format filter. | |
| region | No | Two-letter country code to scope results (e.g. "US", "AU"). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| endDate | No | Only return ads first shown on or before this date, format YYYY-MM-DD (e.g. 2024-12-31). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| platform | No | Platform filter. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Only return ads first shown on or after this date, format YYYY-MM-DD (e.g. 2024-01-01). | |
| advertiserId | No | Advertiser ID. Provide either domain or advertiserId. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_ads_searchGoogle Ads TransparencyInspect
Pull the ads an advertiser is currently running from the Google Ads Transparency Center (creative details, formats, and run dates) as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | A Google Ads Transparency Center URL for a selected advertiser or domain (e.g. https://adstransparency.google.com/advertiser/AR01614014350098432001?region=US). | |
| limit | No | Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_ai_modeGoogle AI ModeInspect
Ask Google AI Mode a prompt and receive the cited answer it generates. AI Mode composes the answer at search time, so repeat calls on one prompt can differ in wording and in which sources are cited. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| prompt | Yes | The question or prompt to answer with Google AI Mode. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_ai_overviewGoogle AI OverviewInspect
Ask Google Search a prompt and receive the AI Overview it generated for that scrape, with every source Google listed. Google regenerates the overview per search, so the same prompt can return different wording and a different source list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| prompt | Yes | The question or prompt to answer with a Google AI Overview. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_autocompleteGoogle AutocompleteInspect
Get Google search autocomplete suggestions for a partial query (keyword ideas). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Two-letter country code for result localization (e.g. us, gb, de). | |
| hl | No | Two-letter interface and results language code for the suggestions (e.g. en, es, de). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The partial Google search query. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_imagesGoogle ImagesInspect
Run a Google Images search and get structured results: image URLs, dimensions, titles, and source pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Two-letter country code for result localization (e.g. us, gb, de). | |
| hl | No | Two-letter interface and results language code (e.g. en, es, de). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of images to return (1-100, default 20). Requests for 10 results or fewer are billed at a lower rate than larger requests. | |
| query | Yes | Image search query (e.g. golden gate bridge at sunset). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Fine-grained location for result localization, given as a canonical Google location string (e.g. 'New York, United States', 'London, United Kingdom'). More specific than the country-level gl. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| timeframe | No | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). | |
| autocorrect | No | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_lensGoogle LensInspect
Reverse image search: find web pages and visual matches for an image URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Public URL of the image to search with. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_newsGoogle NewsInspect
Search Google News by keyword and get fresh articles (headlines, sources, links, and publish times) as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Two-letter country code for result localization (e.g. us, gb, de). | |
| hl | No | Two-letter interface and results language code (e.g. en, es, de). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Requested article count (1-20, default 20). Google News returns its latest matching articles and may return more or fewer than requested. Price is flat per request. | |
| query | Yes | News search query; supports operators like '-', 'OR', and 'site:' (e.g. bitcoin site:cnn.com). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Fine-grained location for result localization, given as a canonical Google location string (e.g. 'New York, United States', 'London, United Kingdom'). More specific than the country-level gl. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| timeframe | No | How far back to search, written as a count plus a unit: h hours, d days, w weeks, m months, y years. So 2h is the last two hours, 30d the last thirty days, 6m the last six months. Omit this field, or send 'all', to search without a time limit. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_patentsGoogle PatentsInspect
Search Google Patents with title, patent number, inventor, assignee, key dates, and PDF link. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The Google Patents search query. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_scholarGoogle ScholarInspect
Search Google Scholar for academic papers with title, authors, citation count, and PDF link. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The Google Scholar search query. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `year`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a record that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_searchGoogle SearchInspect
Run a Google web search and get the organic results (title, link, snippet, position) as clean JSON. Returns about 10 results per call - Google stopped honoring bulk result counts in September 2025, so a limit above 10 is accepted but returns no more than a page. Send page 2, 3, ... to walk further, or use google.search_100 for up to 100 ranked results in one call, which is normally cheaper past roughly 20 results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Two-letter country code for result localization (e.g. us, gb, de). | |
| hl | No | Two-letter interface and results language code (e.g. en, es, de). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Which page of about 10 organic results to return, starting at 1. Send page 2, 3, ... to walk deeper; each page is billed as one request and any source can serve any page. Replaces cursor. | |
| limit | No | Page size to ask for. Google returns about 10 organic results per page and stopped honoring larger counts in September 2025, so a limit above 10 still returns about 10. Some sources return their whole page of about 10 whatever limit says: a page is never trimmed after the call, so nextCursor always continues exactly where this response ended. To go deeper, send page (about 10 results per page, each billed as a request) or use google.search_100, which returns up to 100 ranked results in a single call for one flat charge and is cheaper past roughly 20 results. Price is flat per request. | |
| query | Yes | The Google search query. | |
| cursor | No | Deprecated: send page instead. A continuation token from an earlier response's nextCursor is still accepted and still continues on the source that issued it; page is ignored when cursor is sent alongside it. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Fine-grained location to localize results to, more specific than the country-level gl. Send it as an Active Canonical Name from Google's geo-target list: place, then each parent region, then country, with no space after each comma, e.g. 'New York,New York,United States', 'Austin,Texas,United States', 'London,England,United Kingdom'. Common variations are translated to that name when they point to exactly one place: spaces after commas, missing accents, a US state abbreviation ('Orlando, FL, United States'), or a skipped region ('Sydney, Australia'). A value that names no place, or more than one, is rejected rather than quietly searched from somewhere else. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| timeframe | No | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). | |
| autocorrect | No | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireCursor | No | Deprecated. Every source for this search returns a nextCursor, so this changes nothing about the price or which source serves you; it stays accepted so callers that already send it keep working. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_search_100Google Search Top 100Inspect
Run a Google web search and get up to 100 ranked organic results in one call, with true absolute positions rather than per-page numbering. One flat charge whatever the depth, which makes it cheaper than paging google.search past roughly 20 results. It reads ten pages of Google to build the list, so a call takes around three to four minutes - use google.search when you want the first page back in a second. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Two-letter country code for result localization (e.g. us, gb, de). | |
| hl | No | Two-letter interface and results language code (e.g. en, es, de). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The Google search query. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| timeframe | No | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). | |
| autocorrect | No | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_shopping_searchGoogle Shopping SearchInspect
Search Google Shopping by keyword and get up to 10 product offers (title, price, store, rating, and link), localized by country and language. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-10, default 10). | |
| query | Yes | Product name, brand, or keywords to search for (e.g. "Nike running shoes"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| sortBy | No | Sort order for results (e.g. "LOWEST_PRICE"); defaults to relevance. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | ISO 3166-1 alpha-2 country code for localized results (e.g. "us", "gb", "de"). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | ISO 639-1 language code for results (e.g. "en", "es", "fr"). | |
| condition | No | Only return products in this condition (e.g. "USED"); defaults to any condition. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `listPriceText` or `discountPercent`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_google_videosGoogle VideosInspect
Search Google for video results (YouTube and others) with title, link, thumbnail, and source. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Two-letter country code for result localization (e.g. us, gb, de). | |
| hl | No | Two-letter interface and results language code (e.g. en, es, de). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The video search query. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Fine-grained location for result localization, given as a canonical Google location string (e.g. 'New York, United States', 'London, United Kingdom'). More specific than the country-level gl. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| timeframe | No | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). | |
| autocorrect | No | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `source`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a record that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_hackernews_profileHacker News ProfileInspect
Get a Hacker News user's public profile by username - karma, bio, and account details as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Hacker News username, e.g. "pg". | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_hackernews_searchHacker News SearchInspect
Search Hacker News by keyword - matching stories with title, link, author, points, and comment count as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| tags | No | Optional result filter, e.g. "story" or "comment". | |
| query | Yes | Search keyword, e.g. "ai". | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_hackernews_storyHacker News StoryInspect
Get a Hacker News story by id - title, link, author, points, and comment count as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Hacker News story id, e.g. "47340079". | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_hackernews_story_commentsHacker News Story CommentsInspect
List the comments on a Hacker News story by id - text, author, and timestamp as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Hacker News story id, e.g. "47340079". | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_indeed_jobsIndeed JobsInspect
Search Indeed job listings by keyword, location, and country, with up to 20 normalized job records per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| query | Yes | Job search keywords (e.g. software engineer). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | Two-letter country site code (e.g. us, uk, de). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | City, state, zip, or 'remote'. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| postedLimit | No | Only return jobs posted within this window: 24h (past day) or week (past 7 days). Omit for all dates. This can raise your price: a dearer source serves a request that sets it, and you are quoted and charged its price. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `rating` or `streetAddress`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a listing that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_audio_reelsInstagram Reels by AudioInspect
List Instagram reels that use a given audio track by audio id. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor returned by a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| audioId | Yes | Audio identifier from the Instagram audio page URL. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `reshares`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a reel that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_basic_profileInstagram Basic ProfileInspect
Fetch an Instagram account's core public profile fields (followers, posts, bio, verification) by user id. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| userId | Yes | userId | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `posts`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_comment_repliesInstagram Comment RepliesInspect
List the replies to an Instagram comment with cursor pagination (text, author, likes). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full Instagram post or reel URL the comment belongs to. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| commentId | Yes | Instagram comment ID (a comment's id from the Instagram Post Comments endpoint). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_embedInstagram Profile EmbedInspect
Fetch the public embed HTML for an Instagram profile by handle. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Instagram username without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_followersInstagram FollowersInspect
List about the first 50 followers of any public Instagram account by username: follower usernames, names, and profile details. Instagram caps follower lists, so this returns one page, not the whole list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Today every source behind this endpoint returns a single page of about 50 followers and no continuation cursor, so nextCursor comes back empty and there is no further page to request; this parameter is accepted but has nothing to resume from. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The Instagram username, user ID, or profile URL whose followers to list (e.g. natgeo). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `private`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_followingInstagram FollowingInspect
List about the first 50 accounts a public Instagram user follows: usernames, names, and profile details. Instagram caps these lists, so this returns one page, not the whole list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Today every source behind this endpoint returns a single page of about 50 accounts and no continuation cursor, so nextCursor comes back empty and there is no further page to request; this parameter is accepted but has nothing to resume from. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The Instagram username, user ID, or profile URL whose following list to fetch (e.g. natgeo). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `private`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_hashtag_analyticsInstagram Hashtag AnalyticsInspect
Get the total post count for any Instagram hashtag. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| body | Yes | Get the total post count for any Instagram hashtag. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. |
anyapi_post_v1_run_instagram_hashtag_recent_postsInstagram Hashtag Recent PostsInspect
Instagram posts published under a hashtag, newest first, read from its live chronological feed rather than a web search index. Built for monitoring: results arrive within a couple of minutes of posting, so engagement counts are usually still zero and reels do not appear (Instagram keeps those on a separate tab). For engagement-ranked results use instagram.hashtag_top_posts; for older relevance-ranked results use instagram.search_hashtag. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| hashtag | Yes | Hashtag to monitor, without the leading #. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_hashtag_top_postsInstagram Hashtag Top PostsInspect
Instagram's own top-ranked posts for a hashtag, read from its live hashtag feed rather than a web search index, with view, like, and comment counts. Reels-heavy and engagement-ranked, so it answers what is performing on a tag right now. For older relevance-ranked results with date and media-type filters use instagram.search_hashtag; for the chronological feed use instagram.hashtag_recent_posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| hashtag | Yes | Hashtag to fetch, without the leading #. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `soundTitle`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_highlight_detailInstagram Highlight DetailInspect
Fetch the details and media items of a single Instagram story highlight by id. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The id of the highlight to retrieve details for. | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_location_postsInstagram Location PostsInspect
List public Instagram posts tagged at a location, ranked or most recent, with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Order the posts by Instagram's top ranking or by newest first. Defaults to ranked. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| locationId | Yes | Instagram location id, as returned by instagram.search_locations. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_media_transcriptInstagram Media TranscriptInspect
Get the spoken-audio transcript text for an Instagram post or reel by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Instagram post or reel URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `durationSeconds`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a video that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_postInstagram PostInspect
Fetch a single Instagram post or reel by URL (media URLs, like count, owner, type) as normalized JSON. Turn on hostVideo to also get the post's video on a hosted MP4 link that plays without an Instagram session, charged as an extra on top of the price. If you want the spoken words as well, instagram.reel_transcript transcribes the same reel. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full Instagram post or reel URL, carrying the media shortcode: /p/, /reel/, /reels/, or /tv/. A profile URL such as https://www.instagram.com/username names no post, so it is rejected instead of charged for an empty result - send that account's handle to instagram.profile, or its posts to instagram.user_posts. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| hostVideo | No | Set true to also get the post's video on a hosted MP4 link that plays without an Instagram session. The file is downloaded and stored for you, and the response adds `hostedUrl`, `expiresUtc` and `bytes`. It is charged as an extra on top of the price, and it never changes which source serves you: every source offers it at the same price. A post with no video, or a post that does not exist, is refused with no charge rather than billed for a file that cannot exist. Omit it and nothing is downloaded, nothing is stored, and nothing extra is charged. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `plays`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| requirePlayCount | No | Deprecated; send `requireFields: ["plays"]` instead, which does exactly the same thing. Set true to be served only by a source that reports a reel's play count. Omit it and routing is unchanged, with the cheapest source serving, which does not carry play counts, so `plays` is absent from its responses. This can raise your price: opting in routes to a source that reports the count, and you are quoted and charged its price. It stays accepted so callers that already send it keep working. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_post_likersInstagram Post LikersInspect
List the accounts that liked a public Instagram post, one page of likers per call, with each liker's handle, display name, verified flag and avatar. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Canonical URL of a public Instagram post or reel. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_profile_contactInstagram Profile Contact InfoInspect
Look up the contact email and phone number an Instagram creator or business publishes on its profile, including the address behind the profile's Email button that public profile lookups do not return. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Instagram username without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `isBusiness`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_reels_searchInstagram Reels SearchInspect
Search Instagram Reels by keyword against Instagram's own reels search and get matching reels with view, like and comment counts, caption, creator and duration. Results are relevance-ranked, not chronological. We remove overlap with recent pages, but older reels may reappear during a long search. nextCursor is null when a page contains only reels seen in recent pages. For a web-search-index view of the same keyword, with a recency filter and numbered pages, use instagram.web_reels_search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Search keyword (e.g. "crossfit"). | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `locationName`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a reel that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_searchInstagram SearchInspect
Search Instagram for users, hashtags, or places by keyword and get matching results with names, counts, and links. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| type | No | What to search for: user profiles, hashtags, or places (e.g. hashtag). | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| query | Yes | Keyword to search Instagram for; one or more words without special punctuation (e.g. coffee roastery). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `postsCount`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_search_followersInstagram Search FollowersInspect
Search the followers of a public Instagram account by name or username, using Instagram's own follower search. On smaller accounts it searches the whole follower list and returns close matches ranked by Instagram. On large accounts Instagram does not support searching followers, so the result is the account's most recent followers instead, whatever the query. Returns usernames, names, and profile details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Name or username text to look for among this account's followers (e.g. john). Instagram matches loosely, and on large accounts it does not search followers at all, so the most recent followers come back instead. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The Instagram username whose followers to search, without the leading @ (e.g. milada2788). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_search_followingInstagram Search FollowingInspect
Search the accounts a public Instagram user follows by name or username. Matching is Instagram's own loose search, so results are close matches ranked by Instagram and some may not contain your exact word. Returns usernames, names, and profile details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Name or username text to look for among the accounts this user follows (e.g. skin). Instagram matches loosely, so close matches are returned too. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The Instagram username whose following list to search, without the leading @ (e.g. moogooskincare). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_search_locationsInstagram Location SearchInspect
Search Instagram locations by keyword and return each place's id, name, address and coordinates. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Place name, address or city to search for. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_search_profilesInstagram Profile SearchInspect
Search public Instagram profiles by a bio or caption keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Bio or caption keyword/phrase to search for. | |
| cursor | No | Pagination cursor returned by a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `private`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_search_profiles_contactInstagram Profile Search with ContactInspect
Search public Instagram profiles by a bio or caption keyword and get each account's country, the month it joined, and the public email and phone number it lists. Charged per profile that comes back with those details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Most profiles to return on this page, 1 to 12. | |
| query | Yes | Bio or caption keyword/phrase to search for. | |
| cursor | No | Pagination cursor returned by a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_similar_profilesInstagram Similar ProfilesInspect
List the accounts Instagram recommends as similar to a public profile, with each account's handle, display name, verified flag and avatar. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Instagram username without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_stories_fullInstagram Stories (full)Inspect
Fetch a public Instagram account's currently live stories with media, type, dimensions, posting time, and 24-hour expiry by username. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | Instagram username or handle without the @. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `soundTitle`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a story that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_stories_thinInstagram Stories (basic)Inspect
Fetch a public Instagram account's currently live stories - media URL, owner, and posting time - by username. Lightweight projection; for media type, dimensions, and the 24h expiry time use instagram.stories_full. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | Instagram username/handle to fetch currently live stories for (without the @). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `durationSeconds`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a story that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_tagged_postsInstagram Tagged PostsInspect
List the posts an Instagram user is tagged in, with cursor pagination (author, caption, likes, comments). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Instagram username without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `taggedUsers`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_trending_reelsInstagram Trending ReelsInspect
List currently trending Instagram reels. Instagram does not return play counts on this feed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_user_highlightsInstagram User HighlightsInspect
List an Instagram account's story highlight reels by handle. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Instagram username without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| userId | No | Instagram numeric user id (optional, faster than handle). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `mediaCount`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a highlight that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_user_postsInstagram User PostsInspect
List an Instagram account's recent posts (likes, comments, captions) by handle with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Instagram username without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `userId`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_user_repostsInstagram User RepostsInspect
List the posts a public Instagram account has reposted to its feed, with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| userId | Yes | Instagram's numeric account id, as returned by instagram.profile. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_instagram_web_reels_searchInstagram Reels Web SearchInspect
Search Instagram Reels through a web search index rather than Instagram's own search, and get matching reels (caption, likes, comments, creator, and duration). That is what lets it filter by a recency window and page by number, and it is also why the results are whatever the index has crawled rather than what Instagram ranks right now, and why paging tops out around 110 reels per query (11 pages of 10). Instagram does not return view or play counts here. For Instagram's own live reels search, with view counts, use instagram.reels_search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | 1-based results page. | |
| query | Yes | Search keyword (e.g. "crossfit"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| datePosted | No | Recency hint, not a hard filter. Reel discovery runs on top of Google search, so this window narrows Google's index by when it discovered or last crawled the reel, which is not the same as when the reel was published to Instagram. Returned reels can have a createdUtc outside the requested window, and the narrowest window, last-week, often returns older reels or no results. Check createdUtc yourself if you need exact publication-time precision. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_job_search_theirstackJob Search - TheirStackInspect
Search TheirStack's job-post index by company, technology, keyword, title, seniority, salary, location and how recently the post appeared, and get the hiring company's full firmographic record with every post. Billed per job returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Page number. Required when using page-based pagination. | |
| limit | No | Rows to return on this page, up to TheirStack's maximum of 500. Every row returned is billed. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| jobIds | No | Get jobs with these IDs only. Deprecated parameter, use job_id_or instead. | |
| offset | No | Number of results to skip. Required for offset-based pagination. | |
| remote | No | True: only show remote jobs. False: only show non-remote jobs. None: show all jobs. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| jobIdOr | No | Get jobs with these IDs only. | |
| orderBy | No | List of column objects. You can pass several columns to order by, in order of priority. Only `field` is required, `desc` is True by default. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| jobIdNot | No | Exclude jobs with these IDs. | |
| easyApply | No | If True, only return jobs that can be applied directly through the job board. If False, only return jobs that require redirecting to the company's website. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| industryOr | No | Names of industries, case-insensitive. Results will only include companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_or field instead. | |
| jobTitleOr | No | Natural language patterns to match job titles. Case-insensitive. Only jobs with title that match any of these patterns will be returned. Uses Postgres full text search. | |
| companyIdOr | No | Only return companies that match these IDs exactly. This filter acts as an OR filter, so if you pass more than one company ID, it will return companies that match any of the IDs. | |
| companyType | No | Filter by company type. | |
| industryNot | No | Names of industries, case-insensitive. Results will exclude companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_not field instead. | |
| jobTitleNot | No | Natural language patterns to match job titles. Case-insensitive. Only jobs with title that do not match any of these patterns will be returned. Uses Postgres full text search. | |
| postedAtGte | No | ISO 8601 date string (yyyy-mm-dd). Only jobs published in this date or after will be returned. | |
| postedAtLte | No | ISO 8601 date string (yyyy-mm-dd). Only jobs published in this date or before will be returned. | |
| urlDomainOr | No | Include jobs only if their URL domain (from `url` or `source_url`) is in the provided case-insensitive list. For example, ['greenhouse.io', 'workable.com'] will match URLs containing 'greenhouse.io' or 'workable.com'. Refer to our list of sources at https://theirstack.com/en/docs/data/job/sources. | |
| industryIdOr | No | Industry codes. You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries | |
| maxSalaryUsd | No | Maximum annual salary in USD. For example, 150000 means $150,000. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| minSalaryUsd | No | Minimum annual salary in USD. For example, 100000 means $100,000. | |
| urlDomainNot | No | Exclude jobs if their URL domain (from `url` or `source_url`) is in the provided case-insensitive list. For example, ['greenhouse.io', 'workable.com'] will exclude URLs containing 'greenhouse.io' or 'workable.com'. Refer to our list of sources at https://theirstack.com/en/docs/data/job/sources. | |
| companyNameOr | No | Only return companies that match these names exactly, case-sensitively. This filter acts as an OR filter, so if you pass more than one company name, it will return companies that match any of the names. | |
| companyTagsOr | No | Return companies that match any of these keywords | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| industryIdNot | No | Industry ids to exclude.You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries | |
| jobLocationOr | No | Filter jobs by location. Returns jobs whose locations match ANY of the specified location criteria. Each location criteria is specified using a JobLocationFilter object. (You can find location IDs using the locations catalog endpoint) | |
| maxFundingUsd | No | Maximum company funding, in USD | |
| maxRevenueUsd | No | Maximum company revenue, in USD | |
| minFundingUsd | No | Minimum company funding, in USD | |
| minRevenueUsd | No | Minimum company revenue, in USD | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| companyNameNot | No | Only return companies that don't match these names exactly, case-sensitively. | |
| finalUrlExists | No | (Use `property_exists_or / property_exists_and` instead) Only return jobs with a final URL. Typically jobs that were originally posted on an ATS. If True, only return jobs with a final URL. If False, only return jobs without a final URL. If None, return all jobs. | |
| fundingStageOr | No | Funding stages of companies returned. Possible values: ['angel', 'convertible_note', 'debt_financing', 'equity_crowdfunding', 'other', 'private_equity', 'seed', 'series_a', 'series_b', 'series_c', 'series_d', 'series_e', 'series_f', 'series_g', 'series_h', 'venture_round_not_specified', 'series_i', 'series_j', 'undisclosed', 'series_unknown', 'pre_seed', 'post_ipo_secondary', 'post_ipo_equity', 'post_ipo_debt', 'non_equity_assistance', 'late_vc', 'initial_coin_offering', 'growth_equity_vc', 'grant', 'early_vc', 'corporate_round', 'secondary_market', 'product_crowdfunding'] | |
| jobLocationNot | No | Filter jobs by location. Returns jobs whose locations DO NOT match ANY of the specified location criteria. Each location criteria is specified using a JobLocationFilter object. (You can find location IDs using the locations catalog endpoint) | |
| jobSeniorityOr | No | Will return jobs where the seniority is any of the ones passed here | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyDomainOr | No | Only return companies that match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). This filter acts as an OR filter, so if you pass more than one company domain, it will return companies that match any of the domains. | |
| companyListIdOr | No | Return companies that belong to any of the company lists passed here | |
| discoveredAtGte | No | Only jobs discovered by TheirStack on this date or datetime or after will be returned. In UTC timezone. | |
| discoveredAtLte | No | Only jobs discovered by TheirStack on this date or datetime or before will be returned. In UTC timezone. | |
| onlyYcCompanies | No | Only return YC companies | |
| reportsToExists | No | Only return jobs where we identified the role the hired person would report to. If True, only return jobs where we identified the role the hired person would report to. If False, only return jobs where we didn't identify the role the hired person would report to. If None, return all jobs. | |
| companyDomainNot | No | Only return companies that don't match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). | |
| companyListIdNot | No | Return companies that don't belong to any of the company lists passed here | |
| jobCountryCodeOr | No | 2-letter ISO country code of the location of the job. Can pass more than 1 | |
| jobKeywordSlugOr | No | Will return jobs where any of these keyword slugs appear. Case sensitive. Check out all the keywords we track at GET /v0/catalog/keywords | |
| maxEmployeeCount | No | Maximum number of employees in a company | |
| minEmployeeCount | No | Minimum number of employees in a company | |
| propertyExistsOr | No | Return jobs that have any of these fields not null. For example, if you pass ['final_url'], it will return jobs that have a final_url set. This field also support chaining of fields. For example, if you pass ['company_object.domain', 'company_object.linkedin_url'], it will return jobs that have a company domain or a company linkedin_url set. | |
| jobCountryCodeNot | No | 2-letter ISO country code of the location of the job. Can pass more than 1. Will exclude jobs from these countries | |
| jobKeywordSlugAnd | No | Will return jobs where all of these keyword slugs appear. Case sensitive. Check out all the keywords we track at GET /v0/catalog/keywords | |
| jobKeywordSlugNot | No | Will return jobs where none of these keyword slugs appear. Case sensitive. Check out all the keywords we track at GET /v0/catalog/keywords | |
| jobTitlePatternOr | No | Regex patterns to match job titles. Case-insensitive. Jobs whose job title matches of the filters will be returned. | |
| propertyExistsAnd | No | ||
| companyInvestorsOr | No | Investors of the company | |
| jobTitlePatternAnd | No | Regex patterns to match job titles. Case-insensitive. Only jobs with title that match all of these patterns will be returned. | |
| jobTitlePatternNot | No | Regex patterns to match job titles. Case-insensitive. Jobs whose job title doesn't match any of the patterns will be returned. | |
| postedAtMaxAgeDays | No | Date posted max age in days. If 0, only return jobs posted today. If 1, from today and yesterday, etc. | |
| includeTotalResults | No | When enabled, calculates and returns `total_results` and `total_companies` fields in the response. WARNING: This significantly slows down responses as it requires reading the entire dataset. Recommended usage: enable only for the initial request to get totals, then disable for subsequent pagination requests. | |
| jobTechnologySlugOr | No | Will return jobs where any of these technologies appear. Case sensitive. Pass slugs. Check out all the technologies we track with the technologies endpoint. If you pass more than one technology, we will return jobs that mentnion all of the technologies. | |
| companyCountryCodeOr | No | Return companies whose HQ country code is any of the ones passed here, case sensitive. Pass ISO2 country codes. | |
| companyKeywordSlugOr | No | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| companyLinkedinUrlOr | No | Return companies whose LinkedIn URL matches any of the slugs passed here. Can also pass full LinkedIn company URLs. | |
| employmentStatusesOr | No | Filter jobs by employment status. Returns jobs that match any of the specified employment types. If no values are provided or an empty list is sent, all jobs regardless of employment status will be returned. | |
| hiringManagersExists | No | (Use `property_exists_or / property_exists_and` instead) If True, only return jobs with a hiring manager. If False, only return jobs without a hiring manager. If None, return all jobs. | |
| jobLocationPatternOr | No | Regex patterns to match job locations. Case-insensitive. Searches both the location field and the enhanced locations array (using normalized city and state name fields within each location element). Jobs matching ANY of the provided patterns will be returned. Use this to find jobs in specific cities, states, or regions. | |
| jobTechnologySlugAnd | No | Will return jobs where all of these technologies appear. Case sensitive. Pass slugs. Check out all the technologies we track with the technologies endpoint. | |
| jobTechnologySlugNot | No | Will return jobs where none of these technologies appear. Case sensitive. Pass slugs. Check out all the technologies we track with the technologies endpoint. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| scraperNamePatternOr | No | Regex patterns to match job sources. Case-insensitive. | |
| companyCountryCodeNot | No | Return companies whose HQ country code is not any of the ones passed here, case sensitive. Pass ISO2 country codes. | |
| companyKeywordSlugAnd | No | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| companyKeywordSlugNot | No | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords | |
| jobLocationPatternNot | No | Regex patterns to exclude job locations. Case-insensitive. Searches both the location field and the enhanced locations array (using normalized city and state name fields within each location element). Jobs matching ANY of the provided patterns will be EXCLUDED from results. Use this to filter out specific locations. | |
| onlyJobsWithReportsTo | No | Only return jobs where we identified the role the hired person would report to. Deprecated field, use reports_to_exists instead. | |
| discoveredAtMaxAgeDays | No | If 0, only return jobs added to our database in the current day. If 1, from today and yesterday, etc. | |
| discoveredAtMinAgeDays | No | If 1, only return jobs discovered by TheirStack until yesterday. If 2, until 2 days ago, etc. | |
| maxEmployeeCountOrNull | No | Maximum number of employees in a company. If we don't have company size information, we will return it as well. | |
| minEmployeeCountOrNull | No | Minimum number of employees in a company. If we don't have company size information, we will return it as well. | |
| companyTechnologySlugOr | No | Will return jobs from companies that that have mentioned any of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_or instead. | |
| jobDescriptionPatternOr | No | Regex patterns to look for in job descriptions. Case-sensitive. Results will include jobs whose description matches any of these patterns. Use (?i) at the start of a pattern to make it case-insensitive. Can pass more than one. | |
| lastFundingRoundDateGte | No | Only return companies whose last funding round date is after or on this date. Format: 'YYYY-MM-DD' | |
| lastFundingRoundDateLte | No | Only return companies whose last funding round date is before or on this date. Format: 'YYYY-MM-DD' | |
| companyLinkedinUrlExists | No | (Use `property_exists_or / property_exists_and` instead) Only return companies with a LinkedIn URL | |
| companyLocationPatternOr | No | Return companies whose city matches any of the patterns passed here. Case insensitive. For example, if you pass 'san francisco', it will return companies whose city is 'San Francisco', 'San Francisco Bay Area', etc. | |
| companyTechnologySlugAnd | No | Will return jobs from companies that that have mentioned all of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_and instead. | |
| companyTechnologySlugNot | No | Will return jobs from companies that that haven't mentioned any of these technologies in their jobs. Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_not instead. | |
| jobDescriptionContainsOr | No | Search for whole words in job descriptions using word boundaries (\b). Case-insensitive by default, except for the patterns that are uppercase - in that case we'll respect it. Only finds complete words (e.g., searching 'quality' won't match 'inequality'). Results will include jobs whose description contains any of these words. | |
| jobDescriptionPatternAnd | No | Regex patterns that must ALL match the job description (AND logic). Use (?i) at the start of a pattern to make it case-insensitive. Results will only include jobs whose description matches every pattern in this list. | |
| jobDescriptionPatternNot | No | Regex patterns to look for in job descriptions. Case-sensitive. Results will include jobs whose description don't match any of these patterns. Use (?i) at the start of a pattern to make it case-insensitive. Can pass more than one. | |
| companyNamePartialMatchOr | No | Company names. Will return companies whose name contain any of the the substrings passed here, case-insensitively. For example, if you pass "google", it will return "Google", "Google LLC", "Google Inc", etc. | |
| jobDescriptionContainsNot | No | Exclude jobs whose description contains any of these whole words using word boundaries (\b). Case-insensitive by default, except for the patterns that are uppercase - in that case we'll respect it. Only finds complete words (e.g., searching 'quality' won't match 'inequality'). Results will exclude jobs whose description contains any of these words. | |
| companyNamePartialMatchNot | No | Company names. Will return companies whose name doesn't contain any of the the substrings passed here, case-insensitively. For example, if you pass 'google', it will exclude 'Google', 'Google LLC', 'Google Inc', etc. | |
| onlyJobsWithHiringManagers | No | Only return jobs with a hiring manager. If True, only return jobs with a hiring manager. If False, only return jobs without a hiring manager. If None, return all jobs. | |
| companyDescriptionPatternOr | No | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. | |
| companyDescriptionPatternNot | No | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. | |
| companyNameCaseInsensitiveOr | No | Only return companies that match these names exactly, case-insensitively. | |
| companyInvestorsPartialMatchOr | No | Investors of the company. Will return companies for which any of their investors contains any of the substrings passed here. For example, if you pass 'andree', all funds that match it (like 'Andreessen Horowitz', 'Andreessen Horowitz LLC', etc). | |
| jobDescriptionPatternCaseSensitiveOr | No | Deprecated. Use job_description_pattern_or instead, which now behaves identically. | |
| jobDescriptionPatternIsCaseInsensitive | No | Deprecated. Has no effect. | |
| companyDescriptionPatternAccentInsensitive | No | Set to True to make company description searches accent insensitive. For example, "á" will match "a" as well. |
anyapi_post_v1_run_linkedin_adLinkedIn Ad DetailsInspect
Look up a single LinkedIn Ad Library ad by URL and get the advertiser, headline, creative text, format, CTA, targeting, run dates, and impressions as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | LinkedIn Ad Library ad URL (e.g. "https://www.linkedin.com/ad-library/detail/666281156"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_adsLinkedIn Ads LibraryInspect
Search the LinkedIn Ad Library by search URL and list the matching ads (advertiser, creative text, format). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | LinkedIn Ad Library search URL or a LinkedIn company URL (e.g. https://www.linkedin.com/ad-library/search?companyIds=1035). | |
| limit | No | Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_ads_searchLinkedIn Ad SearchInspect
Search the LinkedIn Ad Library by company or keyword and list matching ads (advertiser, headline, creative text, format, CTA, and run dates) with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | No | Company name to search (e.g. "microsoft"). | |
| endDate | No | Search end date in YYYY-MM-DD format. Today or a later date is moved back to yesterday in UTC when your range overlaps LinkedIn's accepted dates. When you send startDate without endDate, the search ends yesterday in UTC, the latest day LinkedIn accepts. | |
| keyword | No | Keyword term for the ad search. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| companyId | No | LinkedIn company identifier. | |
| countries | No | Comma-separated two-letter country codes (e.g. "US,CA,MX"). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Search start date in YYYY-MM-DD format. An earlier date is moved up to one year ago in UTC when your range overlaps LinkedIn's accepted dates. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| paginationToken | No | Opaque pagination token from a previous response's nextCursor. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_articleLinkedIn ArticleInspect
Read a public LinkedIn article or newsletter issue by URL, including its full body text, author, publication time, and engagement counts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Public LinkedIn article or newsletter issue URL, e.g. https://www.linkedin.com/pulse/your-article-slug. Pair it with the attachmentUrl returned by linkedin.search_posts_full to read the article behind a post. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_company_employeesLinkedIn Company EmployeesInspect
List the employees of a LinkedIn company by name or company URL, with optional job-title filtering. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-10, default 10). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | Yes | Company name or LinkedIn company URL (e.g. google or https://www.linkedin.com/company/google/). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| jobTitle | No | Optional job-title filter supporting boolean operators (e.g. CEO OR CTO). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `openToWork` or `premium`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on an employee who genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_company_posts_thinLinkedIn Company Posts (basic)Inspect
Post text and link only. No engagement counts, author details, media, or reaction breakdown - for those use linkedin.company_posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full LinkedIn company page URL. | |
| page | No | Page number for pagination. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_company_thinLinkedIn Company (basic)Inspect
Basic company: name, description, employee count, industry, logo, website, tagline. No follower count, founded year, office locations, or funding data - for those use linkedin.company. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full LinkedIn company page URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `companyType` or `coverImage`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a company page that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_emailLinkedIn Email FinderInspect
Find the deliverability-validated work email behind a LinkedIn profile URL or public ID. Returns each discovered email with its deliverability, validation status, and quality score, plus the person's name and headline. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| profileUrl | Yes | LinkedIn profile URL or public identifier (the last part of the URL) to find the deliverability-validated work email for. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_jobLinkedIn JobInspect
Fetch one LinkedIn job posting by URL: title, full description, location, salary when disclosed, applicant count, employment and workplace type, seniority, benefits, industries, apply links, posting and expiry dates, the hiring team, the applicant tracking system behind it, and the hiring company with its size, follower count, website and description. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full LinkedIn job posting URL, e.g. https://www.linkedin.com/jobs/view/4431721875/. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_jobsLinkedIn JobsInspect
Search LinkedIn job listings by title and location - full records with description, salary, applicant count, seniority, company details, and benefits. Up to 25 jobs per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Accepted for compatibility and ignored: each call returns one full page of up to 25 jobs at one flat price per call; follow nextCursor for more. | |
| query | Yes | Job title or keywords to search. Supports LinkedIn boolean operators. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of job listings. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| salary | No | Filter by minimum base salary band (US dollars). | |
| sortBy | No | Sort order: most recent (date) or best match (relevance). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | No | Filter to a specific company by name (e.g. Google). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | City, region, or country to search within (e.g. United States, San Francisco). | |
| easyApply | No | When true, only return jobs offering LinkedIn Easy Apply. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| postedLimit | No | Only jobs posted within this window (past hour, 24 hours, week, or month). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| workplaceType | No | Filter by workplace type (remote, hybrid, or onsite). | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| employmentType | No | Filter by employment type. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| experienceLevel | No | Filter by required seniority/experience level. | |
| under10Applicants | No | When true, only return jobs with fewer than 10 applicants (lower competition). | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_jobs_thinLinkedIn Jobs (index)Inspect
Cheap job index: title, company, location, posted date, URL. No description, salary, applicant counts, or seniority - for those use linkedin.jobs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| geoId | No | LinkedIn geo id to target a precise location (e.g. 103644278 for the United States); more exact than the free-text location. | |
| limit | No | Accepted for compatibility and ignored: each call returns one full source page (10 or 25 jobs depending on source); follow nextCursor for more. | |
| query | Yes | Job title or keywords to search. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of job listings. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | City, region, or country to search within. | |
| companyId | No | Filter to a specific company by its LinkedIn numeric company id. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| postedLimit | No | Only jobs posted within this window (past 24 hours, week, or month). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `logoUrl`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a listing that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| workplaceType | No | Filter by workplace type (remote, hybrid, or onsite). | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| employmentType | No | Filter by employment type. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| experienceLevel | No | Filter by required seniority/experience level. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_postLinkedIn PostInspect
Fetch a single LinkedIn post or article by URL (title, text, author, like and comment counts, publish date). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full LinkedIn post or article URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `image`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_post_commentsLinkedIn Post CommentsInspect
List comments on a LinkedIn post - full text, commenter name/URL/job title, timestamps, and engagement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full URL of the LinkedIn post to list comments for. | |
| limit | No | Maximum number of comments to return. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| postedLimit | No | Only return comments posted within this window (default any). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_post_reactionsLinkedIn Post ReactionsInspect
List who reacted to a LinkedIn post - reactor name, profile URL, job title, and reaction type. Lead-gen grade. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | URL of the LinkedIn post to list reactions for (a /posts/...-activity-... or /feed/update/urn:li:activity:... link). | |
| limit | No | Maximum number of reactions to return (1-100, default 100). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `postId`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_post_transcriptLinkedIn Post TranscriptInspect
Get the spoken transcript of a LinkedIn video post by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The full URL of the LinkedIn post to get the video transcript from. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_profile_commentsLinkedIn Profile CommentsInspect
List the comments a LinkedIn member has left on other people's posts - the comment text, its permalink and timestamp, plus the post it was left on and that post's author and engagement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full URL of the LinkedIn member profile whose comments on other people's posts should be listed. | |
| limit | No | Maximum number of comments to return. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| postedLimit | No | Only return comments posted within this window (default any). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `edited` or `isAuthor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a comment that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_profile_posts_fullLinkedIn Profile Posts (full)Inspect
Fetch recent public LinkedIn profile posts with enriched author, engagement, article, newsletter, media, annotation, repost, and social activity details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full URL of the public LinkedIn profile whose posts should be returned. | |
| limit | No | Most posts to return (1-100, default 10). Ignored on sources that page: each call returns one full page of 50 posts; follow nextCursor for more. Sources that cannot page return up to `limit` posts in one call with no nextCursor. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| postedLimit | No | Only return posts published within this relative time window. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| contextCountry | No | Regional LinkedIn context used when retrieving posts. | |
| includeReposts | No | Whether to include reposts that share content without added commentary. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| postedLimitDate | No | Only return posts published on or after this date or timestamp, using a JavaScript-compatible date-time string. | |
| includeQuotePosts | No | Whether to include quote posts that add commentary to shared content. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_profile_posts_thinLinkedIn Profile Posts (basic)Inspect
Fetch recent public LinkedIn profile posts with portable identity, author, engagement, article, image, video, and repost fields. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full URL of the public LinkedIn profile whose posts should be returned. | |
| limit | No | Most posts to return (10-100, default 10). Ignored on sources that page: each call returns one full page of 50 posts; follow nextCursor for more. Sources that cannot page return up to `limit` posts in one call with no nextCursor. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_profile_reactionsLinkedIn Profile ReactionsInspect
List the posts a LinkedIn member has reacted to - the reaction, its timestamp, and the full post it was made on with author and engagement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full URL of the LinkedIn member profile whose reactions to list, for example https://www.linkedin.com/in/williamhgates. | |
| limit | No | Maximum number of reactions to return. One upstream page holds 100. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_profile_thinLinkedIn Profile (basic)Inspect
Lightweight profile: name, avatar, location, followers, public id, current company, and a basic experience/education list (company + dates; job titles, the current-role flag and the connections label only where the source and the profile show them; no descriptions or skills; past companies may be redacted). For full experience detail, skills, certifications, and verified flags use linkedin.profile. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full LinkedIn person profile URL, carrying the profile id after /in/, for example https://www.linkedin.com/in/williamhgates. Any other LinkedIn URL names no person, so it is rejected instead of charged: send a company page to linkedin.company_thin or linkedin.company, and a post to linkedin.post. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `headline` or `recentPosts`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_search_companiesLinkedIn Company SearchInspect
Search LinkedIn companies by keyword with optional location filtering, returning normalized company records. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| query | Yes | Keyword to search LinkedIn companies for (e.g. marketing agency). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Optional location filter, written out in full (e.g. United Kingdom or San Francisco). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_search_posts_fullLinkedIn Post Search (full)Inspect
Search public LinkedIn posts with rich author, engagement, attachment, and poll details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Order results by search relevance or publication date. | |
| limit | No | Maximum number of posts to return (1-100, default 10). The upper bound is one LinkedIn search page. | |
| query | Yes | LinkedIn post search query, including quoted terms or Boolean operators accepted by LinkedIn search. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| authorUrls | No | Only return posts authored by these LinkedIn profile or company URLs. | |
| datePosted | No | Only return posts published within this relative time window. Last-hour and windows beyond one month route to the provider that supports them. | |
| contentType | No | Only return posts carrying this content type. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `attachmentType` or `pollOptions`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| authorKeywords | No | Only return posts whose author profile headline or job title contains at least one of these keywords. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| authorIndustryIds | No | Only return posts by authors associated with these LinkedIn industry IDs. | |
| authorCompanyNames | No | Only return posts by people associated with these company names. | |
| mentioningMemberUrls | No | Only return posts mentioning these LinkedIn member profile URLs. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_linkedin_search_profilesLinkedIn Profile SearchInspect
Search LinkedIn profiles by keyword with optional location and job-title filters. Each match returns a full profile record: name, headline, location, current position, work experience, education, and skills, plus the profile URL, handle, and id. For a cheaper name/headline/URL-only search use linkedin.search_profiles_thin; add emails with linkedin.search_profiles_email. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of full profiles to return (1-25, default 10). You are billed per profile returned, so a lower limit costs less. | |
| query | Yes | Search query for LinkedIn profiles: a role, name, or keywords (e.g. 'Marketing Manager'). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| schools | No | Filter to people who attended any of these schools, by name. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| jobTitle | No | Optional current job title filter (e.g. 'Software Engineer'). | |
| location | No | Optional location filter (e.g. 'San Francisco'). | |
| lastNames | No | Filter to people whose last name matches any of these. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| firstNames | No | Filter to people whose first name matches any of these. | |
| functionIds | No | Filter by job function. Codes: 1=Accounting, 2=Administrative, 3=Arts and Design, 4=Business Development, 5=Community and Social Services, 6=Consulting, 7=Education, 8=Engineering, 9=Entrepreneurship, 10=Finance, 11=Healthcare Services, 12=Human Resources, 13=Information Technology, 14=Legal, 15=Marketing, 16=Media and Communication, 17=Military and Protective Services, 18=Operations, 19=Product Management, 20=Program and Project Management, 21=Purchasing, 22=Quality Assurance, 23=Real Estate, 24=Research, 25=Sales, 26=Customer Success and Support. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| pastCompanies | No | Filter to people who previously worked at any of these companies, by name. | |
| pastJobTitles | No | Filter by a past job title the person held (e.g. ['Product Manager']). | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| excludeSchools | No | Exclude people who attended any of these schools, by name. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyHeadcount | No | Filter by current company size (employee count). Codes: A=Self-Employed, B=1-10, C=11-50, D=51-200, E=201-500, F=501-1,000, G=1,001-5,000, H=5,001-10,000, I=10,001+. | |
| currentCompanies | No | Filter to people who currently work at any of these companies, by name (e.g. ['Google','Meta']). Multiple names widen the match (OR). | |
| excludeLocations | No | Exclude people in any of these locations, by place name. | |
| profileLanguages | No | Filter by the profile's primary language. | |
| seniorityLevelIds | No | Filter by seniority level. Codes: 100=In Training, 110=Entry Level, 120=Senior, 130=Strategic, 200=Entry Level Manager, 210=Experienced Manager, 220=Director, 300=Vice President, 310=CXO, 320=Owner/Partner. | |
| excludeFunctionIds | No | Exclude these job functions (same codes as functionIds). | |
| recentlyChangedJobs | No | When true, only return people who recently changed jobs (a strong sales/recruiting signal). | |
| excludePastCompanies | No | Exclude people who previously worked at any of these companies, by name. | |
| excludePastJobTitles | No | Exclude people who held any of these past job titles. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| yearsOfExperienceIds | No | Filter by total years of experience. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. | |
| excludeCurrentCompanies | No | Exclude people who currently work at any of these companies, by name. | |
| excludeCurrentJobTitles | No | Exclude people whose current job title matches any of these. | |
| excludeSeniorityLevelIds | No | Exclude these seniority levels (same codes as seniorityLevelIds). | |
| recentlyPostedOnLinkedIn | No | When true, only return people who recently posted on LinkedIn (an activity signal). | |
| yearsAtCurrentCompanyIds | No | Filter by tenure at the current company. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. | |
| companyHeadquarterLocations | No | Filter by the location of the person's current company headquarters, by place name (e.g. ['United States']). | |
| excludeCompanyHeadquarterLocations | No | Exclude people whose current company is headquartered in any of these locations. |
anyapi_post_v1_run_linkedin_search_profiles_emailLinkedIn Profile Search + EmailInspect
People search returning a full profile AND a verified work email for each hit. Search LinkedIn profiles by keyword with optional location and job-title filters; each match returns the full profile record (name, headline, location, current position, work experience, education, and skills, plus the profile URL, handle, and id) together with an emails array carrying the discovered work email and its deliverability. Email discovery is best effort and needs the profile to expose a resolvable company domain, so on a broad search many matches return an empty emails array while still billing the email Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of full profiles (with email) to return (1-25, default 10). You are billed per profile returned, so a lower limit costs less. | |
| query | Yes | Search query for LinkedIn profiles: a role, name, or keywords (e.g. 'Marketing Manager'). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| schools | No | Filter to people who attended any of these schools, by name. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| jobTitle | No | Optional current job title filter (e.g. 'Software Engineer'). | |
| location | No | Optional location filter (e.g. 'San Francisco'). | |
| lastNames | No | Filter to people whose last name matches any of these. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| firstNames | No | Filter to people whose first name matches any of these. | |
| functionIds | No | Filter by job function. Codes: 1=Accounting, 2=Administrative, 3=Arts and Design, 4=Business Development, 5=Community and Social Services, 6=Consulting, 7=Education, 8=Engineering, 9=Entrepreneurship, 10=Finance, 11=Healthcare Services, 12=Human Resources, 13=Information Technology, 14=Legal, 15=Marketing, 16=Media and Communication, 17=Military and Protective Services, 18=Operations, 19=Product Management, 20=Program and Project Management, 21=Purchasing, 22=Quality Assurance, 23=Real Estate, 24=Research, 25=Sales, 26=Customer Success and Support. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| pastCompanies | No | Filter to people who previously worked at any of these companies, by name. | |
| pastJobTitles | No | Filter by a past job title the person held (e.g. ['Product Manager']). | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| excludeSchools | No | Exclude people who attended any of these schools, by name. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyHeadcount | No | Filter by current company size (employee count). Codes: A=Self-Employed, B=1-10, C=11-50, D=51-200, E=201-500, F=501-1,000, G=1,001-5,000, H=5,001-10,000, I=10,001+. | |
| currentCompanies | No | Filter to people who currently work at any of these companies, by name (e.g. ['Google','Meta']). Multiple names widen the match (OR). | |
| excludeLocations | No | Exclude people in any of these locations, by place name. | |
| profileLanguages | No | Filter by the profile's primary language. | |
| seniorityLevelIds | No | Filter by seniority level. Codes: 100=In Training, 110=Entry Level, 120=Senior, 130=Strategic, 200=Entry Level Manager, 210=Experienced Manager, 220=Director, 300=Vice President, 310=CXO, 320=Owner/Partner. | |
| excludeFunctionIds | No | Exclude these job functions (same codes as functionIds). | |
| recentlyChangedJobs | No | When true, only return people who recently changed jobs (a strong sales/recruiting signal). | |
| excludePastCompanies | No | Exclude people who previously worked at any of these companies, by name. | |
| excludePastJobTitles | No | Exclude people who held any of these past job titles. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| yearsOfExperienceIds | No | Filter by total years of experience. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. | |
| excludeCurrentCompanies | No | Exclude people who currently work at any of these companies, by name. | |
| excludeCurrentJobTitles | No | Exclude people whose current job title matches any of these. | |
| excludeSeniorityLevelIds | No | Exclude these seniority levels (same codes as seniorityLevelIds). | |
| recentlyPostedOnLinkedIn | No | When true, only return people who recently posted on LinkedIn (an activity signal). | |
| yearsAtCurrentCompanyIds | No | Filter by tenure at the current company. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. | |
| companyHeadquarterLocations | No | Filter by the location of the person's current company headquarters, by place name (e.g. ['United States']). | |
| excludeCompanyHeadquarterLocations | No | Exclude people whose current company is headquartered in any of these locations. |
anyapi_post_v1_run_linkedin_search_profiles_thinLinkedIn Profile Search (basic)Inspect
Cheap people search: name/handle, headline, VANITY profile URL, location. No full profile or email - for full profiles per hit use linkedin.search_profiles, add emails with linkedin.search_profiles_email. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Search query for LinkedIn profiles - a role, name, or keywords (e.g. 'Marketing Manager'). | |
| title | No | Filter by job title or headline (e.g. Head of Talent). | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; a page holds 10 profiles. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | No | Filter by last name (e.g. Okafor). | |
| schoolId | No | Filter by school, using a LinkedIn school id. | |
| firstName | No | Filter by first name (e.g. Jane). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| industryId | No | Filter by industry, using a LinkedIn industry id. | |
| locationId | No | Filter by location, using a LinkedIn geocode id. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| followerOfUrn | No | Return only people who follow this member, given the member's LinkedIn URN. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| pastCompanyId | No | Filter by a previous employer, using a numeric LinkedIn company id. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| profileLanguage | No | Filter by the language the profile is written in (ISO 2-letter code, e.g. en). | |
| currentCompanyId | No | Filter by current employer, using a numeric LinkedIn company id. Comma-separate for several. | |
| serviceCategoryId | No | Filter by service category, using a numeric service-category id. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_maps_contactsGoogle Maps ContactsInspect
Search Google Maps for businesses and enrich each result with contact details (emails, phones, and social profiles from their websites), up to 20 records per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| query | Yes | What you would type in the Google Maps search bar (e.g. dentist). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| website | No | Filter places by whether they list a website: allPlaces (default), withWebsite (only places that have a website), or withoutWebsite (only places without one). Contact enrichment pulls emails and social profiles from a place's website, so withWebsite targets leads that can be enriched. | |
| language | No | Two-letter language code for the results (e.g. en). | |
| location | Yes | Free-text location to search in, ideally city plus country (e.g. Denver, USA). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `city` or `postalCode`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a business that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| placeMinimumStars | No | Only return places with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit for no rating filter. | |
| categoryFilterWords | No | Optional list of Google Maps place-category names to keep; results are limited to places whose category matches one of these. Use lowercase category names as shown on Google Maps (e.g. ["dentist", "orthodontist"]). Omit to include all categories. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_maps_placeGoogle Maps Place LookupInspect
Look up a place on Google Maps by name or search query (optionally scoped to a location) and get the best-matching place with available address, contact, rating, and coordinate details as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The business name or search text to look up, as you would type it into the Google Maps search bar (e.g. Blue Bottle Coffee). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| website | No | Filter by whether the place lists a website: allPlaces (default), withWebsite (only if it has a website), or withoutWebsite (only if it has none). Omit this field, or send allPlaces, to stay on the cheapest price; withWebsite and withoutWebsite route to a dearer source. | |
| language | No | Two-letter language code for the result details (e.g. en). | |
| location | No | Optional free-text location to scope the search, ideally city plus state or country (e.g. San Francisco, CA). Narrows the query to the best match in that area. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `plusCode` or `postalCode`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a place that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| placeMinimumStars | No | Only match a place with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit this field to stay on the cheapest price; a rating floor routes to a dearer source. | |
| categoryFilterWords | No | Optional list of Google Maps place-category names to keep; the match is limited to a place whose category is one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop"]). Omit to allow any category and stay on the cheapest price; a category filter routes to a dearer source. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_maps_reviewsGoogle Maps ReviewsInspect
Fetch up to 100 Google Maps reviews for a place by place ID, sorted the way you need, in one normalized response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Order in which reviews are returned (e.g. newest). | |
| limit | No | Maximum number of results to return (1-100, default 100). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| placeId | Yes | The Google Maps place ID to fetch reviews for (e.g. ChIJj61dQgK6j4AR4GeTYWZsKWw). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Two-letter language code for the review details (e.g. en). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| postedLimit | No | Only return reviews posted within this window: 24h (past 24 hours), week (past 7 days), month (past month), or year (past year). Omit for no recency filter. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `isLocalGuide` or `placeId`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a review that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| reviewsFilterString | No | Only return reviews whose text contains this keyword or phrase (case-insensitive). Omit to return all reviews (e.g. parking). | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_maps_searchGoogle Maps SearchInspect
Search Google Maps for places matching a query and location: up to 20 normalized place records with ratings, addresses, and contact basics per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-20, default 20). Pricing depends on the selected provider and may be flat per request. | |
| query | Yes | What you would type in the Google Maps search bar (e.g. coffee shop). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| website | No | Filter places by whether they list a website: allPlaces (default), withWebsite (only places that have a website), or withoutWebsite (only places without one). Omit this field, or send allPlaces, to stay on the cheapest price; withWebsite and withoutWebsite route to a dearer source. | |
| language | No | Two-letter language code for the results (e.g. en). | |
| location | Yes | Free-text location to search in, ideally city plus country (e.g. Austin, USA). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `cid` or `street`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a place that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| placeMinimumStars | No | Only return places with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit this field to stay on the cheapest price; a rating floor routes to a dearer source. | |
| categoryFilterWords | No | Optional list of Google Maps place-category names to keep; results are limited to places whose category matches one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop", "restaurant"]). Omit to include all categories and stay on the cheapest price; a category filter routes to a dearer source. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_maps_search_nearbyGoogle Maps Nearby SearchInspect
Search Google Maps around an exact latitude and longitude and get up to 20 normalized places per call, each with the address broken into street, city, state, postal code and country. Use this when you have coordinates and want the map viewport centred on them; use maps.search when you only have a place name. Pass the returned nextCursor back as cursor for the next 20 places. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| zoom | No | Google Maps viewport zoom. Lower covers a wider area, higher focuses more tightly around the coordinates. | |
| limit | No | Accepted but does not change the page: every call returns one full Google Maps viewport of about 20 places, never trimmed, so nextCursor continues exactly where this response ended. Price is flat per request. | |
| query | Yes | What you would type in the Google Maps search bar (e.g. coffee shop). | |
| cursor | No | Opaque cursor from a previous response's nextCursor. Pass it back to get the next page of places. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Two-letter language code for the results (e.g. en). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| coordinates | Yes | The exact map centre to search around. Use maps.search instead if you only have a place name. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_mobile_phone_ai_arkMobile Phone - AI ArkInspect
Find a person's mobile phone from a LinkedIn URL or from a domain and full name. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| domain | No | Person's company domain. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| fullName | No | Person's full name. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| linkedinUrl | No | Person's LinkedIn profile URL. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_mobile_phone_leadmagicMobile Phone - LeadMagicInspect
Find a person's mobile phone from a profile URL or email. A no-match answer is a successful, billable result. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| No | |||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| workEmail | No | ||
| profileUrl | No | ||
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| personalEmail | No | ||
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_nextdoor_businessNextdoor BusinessInspect
Fetch one Nextdoor business page by its slug, with phone, email, website, and street address. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of records to return. A business page resolves to one record, so this is always 1. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| market | No | Nextdoor market the page belongs to: "us" (nextdoor.com), "gb" (nextdoor.co.uk), or "ca" (ca.nextdoor.com). Defaults to "us". | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| pageSlug | Yes | Slug of the Nextdoor business page, the last path segment of its /pages/ URL, e.g. "radiant-plumbing-air-conditioning-austin-tx". | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_nextdoor_searchNextdoor Business SearchInspect
Find local businesses listed on Nextdoor by city and trade category, with phone, email, website, and street address. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| city | Yes | Nextdoor city slug, lowercase, with the city and its state or region joined by two hyphens, e.g. "austin--tx" or "york--england". | |
| limit | No | Maximum number of businesses to return (1-20, default 20). You are billed per result returned, so a lower limit costs less. | |
| query | Yes | Business category to look for in that city, e.g. "plumber", "bakery", "electrician". | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| market | No | Nextdoor market the city belongs to: "us" (nextdoor.com), "gb" (nextdoor.co.uk), or "ca" (ca.nextdoor.com). Defaults to "us". | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_people_search_ai_arkPeople Search - AI ArkInspect
Search professional profiles with account, contact, and saved-list filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Zero-based result page. | |
| size | No | Maximum people to return on this page. | |
| lists | No | AI Ark saved-list filter expression. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| account | No | Company-level filters, keyed by filter name. Accepted names: domain, employeeSize, foundedYear, funding, geoLocation, industries, keyword, language, linkedin, metric, naics, name, phoneNumber, productAndServices, retailSize, revenue, socialMedia, socialMediaLink, technologies, technology, type, url, location. Any other name is rejected. Most names take {"any"|"all": {"include": [...], "exclude": [...]}}, for example {"type": {"any": {"include": ["PUBLIC_COMPANY"]}}}. The any/all object goes INSIDE the filter name, never at the top of account. Size and money filters (employeeSize, foundedYear, revenue, retailSize) instead take {"type": "RANGE", "range": {"start": 50, "end": 200}} or {"type": "ALL"|"NONE"}; geoLocation takes {"position": {"lat": 0, "lng": 0}, "radius": 50, "unit": "km"|"mi"}; keyword takes {"any"|"all": {"include"|"exclude": {"content": ["..."], "sources": [{"mode": "WORD"|"SMART"|"STRICT", "source": "NAME"|"KEYWORD"|"SEO"|"DESCRIPTION"|"INDUSTRY"}]}}}. | |
| contact | No | Person-level filters, keyed by filter name. Accepted names: certification, certifications, company, contactLanguage, contactLocation, currentCompany, department, departmentAndFunction, education, experience, fullName, function, keyword, language, linkedin, location, name, pastCompany, profileBadge, seniority, skill, skills, socialMedia, socialMediaFollower, socialMediaLink, socialProfile, title. Any other name is rejected. Names take {"any"|"all": {"include": [...], "exclude": [...]}}, with the any/all object INSIDE the filter name rather than at the top of contact. Free-text search goes through keyword, which takes {"any"|"all": {"include"|"exclude": {"content": ["..."], "sources": [{"mode": "WORD"|"SMART"|"STRICT", "source": "HEADLINE"|"SUMMARY"|"ORGANIZATION"|"SKILL"|"WORK_HISTORY_DESCRIPTION"|"EDUCATION_DESCRIPTION"|"CERTIFICATION"|"PUBLICATION"|"PATENT"|"AWARD"|"COURSE"|"PROJECTS"|"VOLUNTEERING"|"LANGUAGE_SKILL"|"TEST_SCORE"}]}}}, for example {"keyword": {"any": {"include": {"content": ["engineer"], "sources": [{"mode": "SMART", "source": "HEADLINE"}]}}}}. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_people_search_crustdata_v3People Search - Crustdata v3 (legacy)Inspect
Find up to 100 professional profiles by company domain and title keywords. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| body | Yes | Find up to 100 professional profiles by company domain and title keywords. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. |
anyapi_post_v1_run_people_search_fullenrichPeople Search - FullEnrichInspect
Prospect FullEnrich's person database by title, seniority, function, skill, language and location, plus any current or past employer firmographic. Every row carries the person's employer record. Billed per person returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Rows to return on this page, up to FullEnrich's maximum of 100. Every row returned is billed. | |
| cursor | No | Cursor from a previous response's nextCursor. Works at any depth, including past the 10000 offset ceiling. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Rows to skip. FullEnrich caps offset at 10000; past that, page with cursor. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| personIds | No | Filter by FullEnrich person id. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| personNames | No | Filter by person name. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| personSkills | No | Filter by a skill the person lists. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| personLanguages | No | Filter by a language the person speaks. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| personLocations | No | Filter by the person's city, region or country. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| pastCompanyNames | No | Filter by an employer the person worked at before. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyIds | No | Filter by FullEnrich company id of the current employer. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| pastCompanyDomains | No | Filter by the domain of a past employer. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| pastPositionTitles | No | Filter by a job title the person held before. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| personLinkedinUrls | No | Filter by person LinkedIn URL. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyNames | No | Filter by current employer name. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyTypes | No | Filter by current employer ownership type. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| currentCompanyDomains | No | Filter by current employer domain. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentPositionTitles | No | Filter by current job title. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentPositionYearsIn | No | Filter by years spent in the current position. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyHeadcounts | No | Filter by current employer headcount band. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyIndustries | No | Filter by current employer industry. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanySpecialties | No | Filter by a current employer specialty. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyFoundedYears | No | Filter by current employer founding year. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyHeadquarters | No | Filter by current employer headquarters location. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentCompanyLinkedinUrls | No | Filter by current employer LinkedIn URL. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentPositionJobFunctions | No | Filter by current job function. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentPositionSubFunctions | No | Filter by current job sub-function. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. | |
| currentPositionSeniorityLevel | No | Filter by seniority, e.g. Owner, Founder, C-level, VP, Director, Manager. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
anyapi_post_v1_run_people_search_lushaPeople Search - LushaInspect
Prospect Lusha's contact database by department, seniority, job title, location, company size, industry and technology. One flat price per page; reveal a contact's email and phone with Person Enrichment - Lusha. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| pages | No | Which page of results to return. Lusha charges one flat price per page whatever its size. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| filters | Yes | Prospecting filters. Two keys are accepted, contacts and companies, and each takes an include and an exclude object. contacts.include and contacts.exclude accept departments, seniority, locations, existing_data_points and signals; companies.include and companies.exclude accept names, locations, sizes, revenues, technologies, intentTopics, mainIndustriesIds, subIndustriesIds, naicsCodes and sicCodes. Locations are objects such as {"country": "United States"}; sizes and revenues are ranges such as {"min": 200, "max": 500}. Example: {"companies": {"include": {"names": ["PostHog"]}}, "contacts": {"include": {"departments": ["Engineering & Technical"]}}}. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| excludeDnc | No | Exclude contacts whose phone numbers are all marked do-not-call. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| includePartialContact | No | Include contacts Lusha holds only partial information for. Defaults to true upstream. |
anyapi_post_v1_run_people_search_peopledatalabsPeople Search - People Data LabsInspect
Search People Data Labs' person dataset with SQL or an Elasticsearch query. Results carry the professional and firmographic record plus availability flags for contact data; pull the actual email and phone with Person Enrichment - People Data Labs. Billed per profile returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sql | No | People Data Labs SQL, in the form SELECT * FROM person WHERE ... . String literals take single quotes, only SELECT * is supported, and field names must be real People Data Labs person fields including nested subfields such as experience.title.name. Do not include a LIMIT clause; People Data Labs rejects it. Use limit instead. Send this or query, never both. | |
| limit | No | Maximum profiles to return. Every profile returned is billed, so start at 1 to check a query and read total before asking for more. | |
| query | No | Elasticsearch-style query over the People Data Labs person dataset, e.g. {"bool": {"must": [{"term": {"job_company_website": "posthog.com"}}]}}. Send this or sql, never both. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| dataset | No | People Data Labs dataset to search, when your plan exposes more than one. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| titlecase | No | Return text in title case instead of People Data Labs' lowercase default. | |
| dataInclude | No | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; billing still follows profiles returned. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_people_search_prospeoPeople Search - ProspeoInspect
Prospect Prospeo's contact database by job title, department, seniority, experience, location and any company firmographic. One flat price per page of 25. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Page number, one-based. Prospeo returns 25 results per page and charges one flat price per page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | No | Filter by company names or websites, e.g. {"names": {"include": ["Stripe"]}, "websites": {"include": ["stripe.com"]}}. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| personName | No | Filter by person name. | |
| companySics | No | Filter by SIC codes. | |
| companyType | No | Filter by ownership type. | |
| companyNaics | No | Filter by NAICS codes. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| companyFounded | No | Filter by founding year range. | |
| companyFunding | No | Filter by funding stage or amount raised. | |
| companyRevenue | No | Filter by revenue range. | |
| personJobTitle | No | Filter by job title, with exact, contains and boolean semantics, e.g. {"include": ["VP Sales"]}. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| companyIndustry | No | Filter by company industry. | |
| companyKeywords | No | Filter by keywords found in company data. | |
| personSeniority | No | Filter by seniority. Prospeo's own values are case sensitive: Founder/Owner, C-Suite, Partner, Vice President, Head, Director, Manager, Senior, Entry, Intern. Common aliases such as vp and founder are normalized before the call. | |
| personDepartment | No | Filter by department. | |
| companyAttributes | No | Filter by company characteristics, e.g. B2B, has pricing, has a free trial. | |
| companyTechnology | No | Filter by technologies the company uses. | |
| maxPersonPerCompany | No | Cap how many people one company may contribute to the results. | |
| companyEmailProvider | No | Filter by the company's email MX provider. | |
| personContactDetails | No | Filter by which contact channels Prospeo holds for the person. | |
| personLocationSearch | No | Filter by where the person is located. | |
| personNameOrJobTitle | No | Free-text search across person name and job title. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| companyHeadcountRange | No | Filter by Prospeo's predefined employee count bands. | |
| companyLocationSearch | No | Filter by company headquarters location. | |
| companyHeadcountCustom | No | Filter by a custom employee count range. | |
| companyHeadcountGrowth | No | Filter by headcount growth. | |
| personDuplicateControl | No | Duplicate-control settings exported from the Prospeo dashboard. | |
| personYearOfExperience | No | Filter by total years of experience, as a numeric range. | |
| personTimeInCurrentRole | No | Filter by time in the current role, as a numeric range. | |
| companyJobPostingQuantity | No | Filter by how many roles the company has open. | |
| companyJobPostingHiringFor | No | Filter by the roles the company is currently hiring for. | |
| personTimeInCurrentCompany | No | Filter by time at the current company, as a numeric range. | |
| companyHeadcountByDepartment | No | Filter by headcount within a department. |
anyapi_post_v1_run_people_search_quickenrichPeople Search - QuickEnrichInspect
Build a prospect list by title, industry, headcount, revenue, or location, and see which people have a work email or phone on file before you pay to reveal one. Contact values themselves are masked here; use Person Enrichment or the QuickEnrich company contacts search to resolve them. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| city | No | Filter on city name. | |
| page | No | One-based result page. | |
| limit | No | Maximum people to return on this page. | |
| title | No | Filter on job title. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | Filter on ISO 3166-1 alpha-2 country code, e.g. "US". | |
| revenue | No | Filter on employer revenue band. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| hasEmail | No | Keep only people with a work email on file. The address itself is not returned here. | |
| hasPhone | No | Keep only people with a phone on file. The number itself is not returned here. | |
| industry | No | Filter on the employer's LinkedIn industry label. Values must match the QuickEnrich industry vocabulary exactly, e.g. "IT Services and IT Consulting". | |
| locality | No | Filter on locality. | |
| services | No | Filter on the services the employer lists. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyName | No | Filter on employer name. | |
| linkedinBio | No | Filter on words found in the employer's LinkedIn bio. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | No | Filter on employer website domain. | |
| employeeCount | No | Filter on employer headcount band. These bands differ from the companyEmployeeCount string returned on a result. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_people_search_quickenrich_companyPeople Search - QuickEnrich Company ContactsInspect
List the known contacts at one company domain, with work emails and direct phone lines where they are held. Returns up to 20 people per page for a flat per-request price. Coverage is strongest for small and local businesses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | One-based result page. Each page holds up to 20 people. | |
| title | No | One job title, or several comma-separated, e.g. "CEO, CFO". | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | Yes | Company website domain, normalized upstream (example.com or https://example.com both work). | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_perplexity_searchPerplexity SearchInspect
Ask Perplexity a web-grounded question and receive an answer with source citations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| prompt | Yes | Question or research prompt for Perplexity to answer using web search. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `createdUtc`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a result that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_person_enrichment_bettercontactPerson Enrichment - BetterContactInspect
Run one contact through BetterContact's email waterfall from a name plus company domain or a LinkedIn URL, and get the winning address with its deliverability verdict, the provider that found it, and the employer record. Only a matched contact is billable. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | No | Employer name, for when you have no domain. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | Yes | Contact's last name. | |
| firstName | Yes | Contact's first name. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| linkedinUrl | No | Contact's LinkedIn profile URL, which raises the match rate. | |
| customFields | No | Arbitrary identifiers echoed back on the result, for joining the answer to your own records. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | No | Employer domain, e.g. stripe.com. The strongest company signal for the waterfall. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_person_enrichment_crustdata_v3Person Enrichment - Crustdata v3Inspect
Enrich one person from a LinkedIn profile URL or a business email: profile, headline, location, skills, current and past roles with the employer's domain, education, social handles, and GitHub profiles. Contact details are sold separately by Contact Enrichment - Crustdata v3. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| No | The person's business email address. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| linkedinUrl | No | LinkedIn profile URL, e.g. https://www.linkedin.com/in/satyanadella. Send exactly one of linkedinUrl or email. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| minSimilarityScore | No | For an email lookup, the lowest match similarity from 0 to 1 to accept. Leave unset to use Crustdata's default. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_person_enrichment_fullenrich_reverse_emailReverse Email Lookup - FullEnrichInspect
Turn up to 99 email addresses into the people behind them: name, headline, location, LinkedIn profile, current title and seniority, full employment history, education, languages and skills, plus the employer record. Only the addresses it resolves are returned, and only those are billed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| contacts | Yes | Addresses to look up, up to 99 per call. You are charged only for the addresses that resolve to a person, though the funds held cover every address you submit until the call settles. Each entry is an object so you can tag it; the address itself goes in email. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_person_enrichment_lushaPerson Enrichment - LushaInspect
Enrich one person into work email, direct dial, job title and employer firmographics from a LinkedIn URL, an email, or a name plus company. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| No | Known email address, used to resolve the person's identity. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| signals | No | Include buying-intent signals in the response. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | No | Last name. Send with firstName plus companyName or companyDomain. | |
| firstName | No | First name. Send with lastName plus companyName or companyDomain. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyName | No | Employer name. Secondary identifier for a name-based lookup; companyDomain matches more reliably. | |
| linkedinUrl | No | LinkedIn profile URL (linkedin.com/in/...). Highest match rate. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| revealEmails | No | Reveal email addresses. Defaults to true upstream. | |
| revealPhones | No | Reveal phone numbers. Defaults to true upstream. | |
| companyDomain | No | Employer domain, e.g. apollo.io. Secondary identifier for a name-based lookup. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| refreshJobInfo | No | Force a fresh job title and employer lookup instead of the cached one. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_person_enrichment_peopledatalabsPerson Enrichment - People Data LabsInspect
Enrich one person into work email, personal emails, mobile phone, full work history, education and employer firmographics from any identifier People Data Labs can match on. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| name | No | Full name, as an alternative to firstName plus lastName. | |
| No | Any email address the person has used. | ||
| pdlId | No | People Data Labs persistent person id, as returned by this SKU's pdlId output. | |
| phone | No | Phone number in international form, e.g. +16176695906. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | State or region to match on. | |
| school | No | School the person attended, used to disambiguate a name match. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | No | Company name, website or social URL where the person has worked. | |
| country | No | Country to match on. | |
| profile | No | Social profile URL the person has used, e.g. a LinkedIn, Twitter, Facebook or GitHub profile. The strongest single identifier. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| lastName | No | Last name. Send with firstName plus company, school or location. | |
| locality | No | City or locality to match on. | |
| location | No | Free-form location string, e.g. brookline, massachusetts, united states. | |
| required | No | People Data Labs boolean expression over top-level fields that a match must satisfy, e.g. personal_emails or (emails and phone_numbers). | |
| birthDate | No | Known birth date, to disambiguate a name match. | |
| emailHash | No | SHA-256 or MD5 hash of an email address, for privacy-preserving matching. | |
| firstName | No | First name. Send with lastName plus company, school or location. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| titlecase | No | Return text in title case instead of People Data Labs' lowercase default. | |
| linkedinId | No | LinkedIn numeric member id (PDL calls this lid). | |
| middleName | No | Middle name. | |
| postalCode | No | Postal or ZIP code to match on. | |
| dataInclude | No | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; it does not reduce what the call costs. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| minLikelihood | No | Minimum People Data Labs likelihood score a match must reach to count as found. Omitted, this SKU sends 6; the People Data Labs default is 2. | |
| streetAddress | No | Street address to match on. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeIfMatched | No | Report which of the sent identifiers actually matched. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_person_enrichment_prospeoPerson Enrichment - ProspeoInspect
Enrich one person into work email, mobile phone, full job history and employer firmographics from a LinkedIn URL, an email, or a name plus company domain. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| No | Known email address, used as the sole identity seed for a reverse lookup. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| fullName | No | Full name, as an alternative to firstName plus lastName. | |
| lastName | No | Last name. | |
| personId | No | Prospeo person id from an earlier People Search - Prospeo call. | |
| firstName | No | First name. Send with lastName plus companyWebsite for the best hit rate. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyName | No | Employer name. Avoid sending it alone; many companies share a name. | |
| linkedinUrl | No | LinkedIn profile URL. The most accurate identifier, alone or with a name. | |
| enrichMobile | No | Reveal the mobile number. Without it the number comes back masked. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| companyWebsite | No | Employer domain, e.g. stripe.com. Preferred over companyName. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| onlyVerifiedEmail | No | Return a match only when Prospeo has a verified email for it. Defaults to false. | |
| companyLinkedinUrl | No | Employer LinkedIn page URL, for a more precise match. | |
| onlyVerifiedMobile | No | Return a match only when Prospeo has a verified mobile for it. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_person_enrichment_quickenrichPerson Enrichment - QuickEnrichInspect
Turn a work email into the person behind it: name, title, LinkedIn, and their employer's firmographics. Coverage is strongest for small and local businesses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| Yes | Exact work email address to look up. | ||
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_pinterest_searchPinterest SearchInspect
Search Pinterest by keyword and get pin, video, board, or profile results with titles, images, and links. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| type | No | Kind of results to return: all pins, only video pins, boards, or profiles (e.g. videos). | |
| limit | No | Page size to ask for (1-20). Some sources return their whole page of about 20 pins whatever limit says: a page is never trimmed after the call, so nextCursor continues exactly where this response ended. | |
| query | Yes | Keyword, topic, brand, or theme to search Pinterest for (e.g. mid-century living room). | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `description` or `videoUrl`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be null on a pin that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_playstore_reviewsGoogle Play ReviewsInspect
Fetch Google Play reviews for any Android app by package name or store URL: ratings, review text, dates, and helpfulness votes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| appId | Yes | Android app package name or full Google Play store URL (e.g. com.supercell.brawlstars). | |
| limit | No | Maximum number of results to return (1-100, default 100). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| rating | No | Only return reviews with this exact star rating from 1 to 5 (e.g. 1); omit for all ratings. | |
| sortBy | No | Review ordering: mostRelevant, newest, or rating (e.g. newest). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| endDate | No | Only return reviews on or before this date, inclusive, in YYYY-MM-DD format (e.g. 2026-06-30). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | No | Only return reviews whose text contains one of these keywords (e.g. ["crash", "login"]). | |
| languages | No | Only return reviews in these ISO 639-1 languages (e.g. ["en", "es"]). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| appVersion | No | Only return reviews left on these app versions (e.g. ["2.24.1", "2.24.2"]). | |
| deviceType | No | Only return reviews from this device type (e.g. "tablet"); omit for the provider default. | |
| recentDays | No | Only return reviews from the last N days (e.g. 30); omit for no time limit. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `title` or `appId`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a review that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_property_records_enformionProperty Records - EnformionInspect
Look up the public property records for one US address: current and previous owners, parcel number (APN), last sale, assessed and market values, property tax, beds, baths, living area, lot size, year built, land use, and zoning. One address can match several parcels, and every match is returned. Billed only when a record is found. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| zip | No | Five-digit ZIP code, optionally with its four-digit extension, e.g. 78725. | |
| city | Yes | City of the property, e.g. Austin. | |
| state | Yes | US state of the property, as its two-letter code, e.g. TX. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| street | Yes | Street line of one US property address, e.g. 4510 Secure Ln. Include a unit number when there is one. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_realtor_searchRealtor.com SearchInspect
Search Realtor.com listings by location with optional price, property-type, beds/baths, listing-status, and keyword filters and get property records (price, address, beds, baths) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-25, default 25). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| bedsMin | No | Minimum number of bedrooms (e.g. 3). | |
| keyword | No | Free-text keyword that must appear in the listing description (e.g. 'pool'). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| bathsMin | No | Minimum number of bathrooms (e.g. 2). | |
| location | Yes | City, ZIP code, neighborhood or state to search (e.g. Las Vegas, NV). | |
| priceMax | No | Maximum listing price in USD (e.g. 750000). | |
| priceMin | No | Minimum listing price in USD (e.g. 250000). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| searchMode | No | Listing type to search: for_sale or sold (e.g. for_sale). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| propertyTypes | No | Filter by one or more property types; omit for all types (e.g. ["single_family", "townhomes"]). | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| searchStatuses | No | Listing statuses to include in for_sale mode; omit for active For Sale + Ready to Build. Ignored in sold mode (e.g. ["for_sale", "pending"]). | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_avatarReddit AvatarInspect
Get a Reddit user's profile picture URL, karma, and account age by username. The cheapest Reddit user lookup; use reddit.profile for bio, trophies, and post and comment counts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | Reddit username, without the u/ prefix. Example: "spez". | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_postReddit PostInspect
Fetch a single Reddit post by URL, including its full body text, score, comment count, upvote ratio, and subreddit, as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Reddit post URL on reddit.com, e.g. "https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/". The /r/<subreddit>/comments/<id>/, /user/<name>/comments/<id>/, /comments/<id>/ and /gallery/<id> forms are accepted. Any other link, such as a share link or a link to another site, is refused as invalid input, with no charge. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_post_transcriptReddit Post TranscriptInspect
Extract the spoken transcript from a Reddit video post by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Reddit post URL or direct v.redd.it video URL to transcribe. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Optional two-letter language code (defaults to en). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_profileReddit ProfileInspect
Fetch a Reddit user's public profile (karma split, post and comment counts, bio, avatar, account age) by username. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | Reddit username, without the u/ prefix. Example: "spez". | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `verified`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_searchReddit SearchInspect
Search Reddit posts across all subreddits by query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Result sort order. | |
| query | Yes | Free-text search across all of Reddit. Reddit's field operators are supported inside the string: subreddit:<name> to scope to one subreddit, author:<user>, title:<text>, selftext:<text>, self:yes|no, nsfw:yes|no, and boolean AND/OR/NOT. To restrict to a single subreddit you can use subreddit:<name> here, or use the reddit.subreddit_posts SKU for a plain subreddit listing. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of results. Include `nextCursor` in requireFields on the first request to make sure a source that supports pagination serves it. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| timeframe | No | Time window for results. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor` or `media`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. Name `nextCursor` only if you will fetch more than the first page: when you leave it out, a cheaper source that cannot paginate may serve the request, and its nextCursor is null, so there is no next page to ask for. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_subreddit_detailsReddit Subreddit DetailsInspect
Fetch a subreddit's metadata (weekly active users, description, and category). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| subreddit | Yes | Subreddit name without the r/ prefix. Case-sensitive (e.g. "AskReddit", not "askreddit"). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `weeklyActiveUsers` or `advertiserCategory`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a subreddit that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_subreddit_postsReddit Subreddit PostsInspect
Fetch posts from a subreddit listing (hot, new, or top). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Listing sort order. | |
| after | No | Legacy pagination alias. Prefer `cursor`; omit both fields for the first page. | |
| limit | No | Page size to ask for (up to 100). Some sources honor it; others always return their whole page of about 25 posts. A page is never trimmed after the call, so pass nextCursor back as cursor to continue exactly where this response ended. | |
| cursor | No | Opaque pagination cursor from a previous response's `nextCursor`; omit for the first page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| subreddit | Yes | Subreddit name without the leading r/ (e.g. "golang"). | |
| timeframe | No | Time window, applied when sort is "top" (e.g. "year" for the year's top posts). Ignored for hot/new. Omit to default to the current day for top. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `isArchived` or `selftext`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_subreddit_searchReddit Subreddit SearchInspect
Search posts within a single subreddit by query, sort, and timeframe. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Optional sort order: relevance, hot, top, new, comments. | |
| query | No | Optional search query to match posts (e.g. 'push ups'). | |
| cursor | No | Optional pagination token from a previous response. Include `nextCursor` in requireFields on the first request to make sure a source that supports pagination serves it. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| subreddit | Yes | Subreddit name without the r/ prefix (e.g. 'Fitness'). | |
| timeframe | No | Optional time filter: all, year, month, week, day, hour. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor` or `selftext`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. Name `nextCursor` only if you will fetch more than the first page: when you leave it out, a cheaper source that cannot paginate may serve the request, and its nextCursor is null, so there is no next page to ask for. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_trending_postsReddit Trending PostsInspect
Get currently trending Reddit posts across all subreddits with stable cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| after | No | Pagination cursor from a previous response's nextCursor. Omit for the first page. | |
| limit | No | Maximum number of trending posts to return (1-100, default 25). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_user_commentsReddit User CommentsInspect
List a Reddit user's comments by username, sorted by new, top, hot, or controversial, with the parent post title and subreddit on every item and cursor pagination. Comment text comes back as a roughly 300-character preview rather than the full body, and this endpoint carries no per-comment permalink; use reddit.post_comments for full comment bodies and comment URLs on a given post. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Sort order for the user's comments. Defaults to new (most recent first). | |
| limit | No | Page size to ask for (up to 100, default 25). Some sources honor it; others always return their whole page of about 25 comments. A page is never trimmed after the call, so pass nextCursor back as cursor to continue exactly where this response ended. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it back to fetch the next page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | Reddit username, without the u/ prefix. Example: "spez". | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_reddit_user_postsReddit User PostsInspect
List a Reddit user's posts by username, sorted by new, top, hot, or controversial, with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Sort order for the user's posts. Defaults to new (most recent first). | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it back to fetch the next page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | Reddit username without the leading u/ prefix (e.g. "spez"). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `isArchived` or `isLocked`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_redfin_propertyRedfin PropertyInspect
Fetch full details for a single Redfin home by its listing URL (price, beds, baths, square feet, address, listing agent, description and photos) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Redfin home details URL (e.g. https://www.redfin.com/TX/Austin/1819-Village-Oak-Ct-78704/home/30981993). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_redfin_searchRedfin SearchInspect
Run a Redfin map search by URL and get matching home listings (price, address, beds, baths, status) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Redfin search results URL for a city, ZIP or map area (e.g. https://www.redfin.com/city/30772/CA/San-Francisco). | |
| limit | No | Maximum number of results to return (1-25, default 25). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `description`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a listing that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_rednote_noteRedNote (Xiaohongshu) NoteInspect
Look up a RedNote (Xiaohongshu) note by note ID and return normalized note details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| noteId | Yes | RedNote (Xiaohongshu) note ID. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_rednote_note_commentsRedNote (Xiaohongshu) Note CommentsInspect
List comments on a RedNote (Xiaohongshu) note and return normalized comment records with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from the previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| noteId | Yes | RedNote (Xiaohongshu) note ID. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_rednote_profileRedNote (Xiaohongshu) ProfileInspect
Look up a RedNote (Xiaohongshu) profile by user ID and return normalized profile details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| userId | Yes | RedNote (Xiaohongshu) user ID. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_rednote_searchRedNote (Xiaohongshu) SearchInspect
Search RedNote (Xiaohongshu) notes by keyword and return normalized note records with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Sort order for matching notes. | |
| query | Yes | Keyword to search for on RedNote (Xiaohongshu). | |
| cursor | No | Pagination cursor from the previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_rednote_search_usersRedNote (Xiaohongshu) User SearchInspect
Search RedNote (Xiaohongshu) users by keyword and return normalized user records with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Keyword to search for on RedNote (Xiaohongshu). | |
| cursor | No | Pagination cursor from the previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_rednote_user_notesRedNote (Xiaohongshu) User NotesInspect
List notes posted by a RedNote (Xiaohongshu) user and return normalized note records with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from the previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| userId | Yes | RedNote (Xiaohongshu) user ID. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_backlinks_summarySEO Backlinks SummaryInspect
Get AnyAPI SEO backlink profile totals for a domain or URL: backlinks, referring domains, authority rank, spam score, and broken links as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| target | Yes | Domain, subdomain, or full page URL to analyze. Send a domain without a protocol or leading www. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeSubdomains | No | Count links pointing at the target's subdomains as well as the target itself. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_competitors_domainSEO Competitor DomainsInspect
Get AnyAPI SEO competitor domains for a target domain with shared keyword counts and organic metrics as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of competitor domains to return. You are billed per returned result, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| target | Yes | Domain to analyze, without a protocol or leading www. | |
| orderBy | No | Sort order for the returned competitors: by shared keyword count (intersections), organic keyword count, organic traffic value (etv), or average position. Omit for the default order. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code for SEO competitor metrics. | |
| location | No | Location code for SEO competitor metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_domain_intersectionSEO Domain IntersectionInspect
Get AnyAPI SEO keyword overlap for two domains with each domain's rankings, URLs, volume, CPC, and difficulty as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of keywords to return. You are billed per returned result, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| orderBy | No | Sort order for the returned keywords: by search volume, cost per click, or keyword difficulty, ascending or descending. Omit for the default order. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| target1 | Yes | First domain to compare, without a protocol or leading www. | |
| target2 | Yes | Second domain to compare, without a protocol or leading www. | |
| language | No | Language code for SEO overlap metrics. | |
| location | No | Location code for SEO overlap metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| intersections | No | When true (the default), return keywords both domains rank for (overlap). When false, return keywords the first domain ranks for that the second domain does NOT (the content-gap query); in that mode secondRank and secondUrl are absent. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_domain_rank_overviewSEO Domain Rank OverviewInspect
Get AnyAPI SEO domain ranking, organic traffic, and paid traffic metrics as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| target | Yes | Domain to analyze, without a protocol or leading www. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code for SEO domain metrics. | |
| location | No | Location code for SEO domain metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_domains_by_technologySEO Domains By TechnologyInspect
Find websites running a given technology, category, or on-page term: domain, rank, detected stack, contacts, and social profiles as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| group | No | Top-level technology group to match, for example marketing or servers. The broadest selector. | |
| limit | No | Maximum number of domains to return in this response. You are billed per returned result, so a lower limit costs less. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. Omit for the first page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| keyword | No | On-page term to match in the site's HTML, for example highlevel. Use this to find sites running a product that the technology index does not detect by name. | |
| orderBy | No | Sort order for the returned domains: by domain rank descending or ascending, by most recently crawled, or by country code. Omit for the default order. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| category | No | Technology category to match, for example marketing_automation. Broader than technology: it returns every domain running anything in that category. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| technology | No | Exact technology name to match, for example Nginx or HubSpot. Only technologies present in the detection index are accepted; any other name is rejected with a 400 error and no charge, so use keyword instead when a product is not matched by name. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_domain_technologiesSEO Domain TechnologiesInspect
Detect the technology stack a website runs: CMS, analytics, marketing, hosting, and security, plus contacts and social profiles as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| domain | Yes | Domain to analyze, without a protocol or leading www. Billing is flat per request. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_keyword_difficultySEO Keyword DifficultyInspect
Get AnyAPI SEO keyword difficulty scores for one or more keywords as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | Yes | SEO keywords to score for organic ranking difficulty. | |
| language | No | Language code for SEO keyword difficulty metrics. | |
| location | No | Location code for SEO keyword difficulty metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_keyword_ideasSEO Keyword IdeasInspect
Find AnyAPI SEO keyword ideas from seed terms with volume, CPC, competition, difficulty, and intent as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of keyword ideas to return. You are billed per returned result, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| orderBy | No | Sort order for the returned ideas: by search volume, cost per click, or keyword difficulty, ascending or descending. Omit for the default order. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | Yes | Seed SEO keywords used to generate related keyword ideas. | |
| language | No | Language code for SEO metrics. | |
| location | No | Location code for SEO metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| closelyVariants | No | When true, generate only close variants of the seed keywords; when false (the default), generate a broader set of related ideas. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_keyword_overviewSEO Keyword OverviewInspect
Get AnyAPI SEO keyword metrics including search volume, CPC, competition, difficulty, and search intent as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | Yes | SEO keywords to analyze. | |
| language | No | Language code for SEO metrics. | |
| location | No | Location code for SEO metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_keyword_suggestionsSEO Keyword SuggestionsInspect
Find AnyAPI SEO keyword suggestions from a seed term with volume, CPC, competition, difficulty, and intent as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of keyword suggestions to return. You are billed per returned result, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| keyword | Yes | Seed SEO keyword used to generate keyword suggestions. | |
| orderBy | No | Sort order for the returned suggestions: by search volume, cost per click, or keyword difficulty, ascending or descending. Omit for the default order. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code for SEO metrics. | |
| location | No | Location code for SEO metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| exactMatch | No | When true, only return suggestions that contain the exact seed phrase; when false (the default), allow reordered and partial-match suggestions. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_llm_mentionsSEO LLM MentionsInspect
Find AI answers that mention a domain or keyword, from Google AI Overviews or ChatGPT, each with the question asked, the answer, its cited sources, and AI search volume as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of AI answers to return. You are billed per returned result, so a lower limit costs less. | |
| domain | No | Domain whose mentions to find, without a protocol or leading www. Send domain or keyword, not both. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| keyword | No | Brand name or phrase whose mentions to find. Send domain or keyword, not both. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code to restrict answers to, for example en. Omit for every language. | |
| location | No | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. | |
| platform | No | AI surface to search: google for Google AI Overviews, chat_gpt for ChatGPT. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_llm_top_brandsSEO LLM Top BrandsInspect
Rank the brands ChatGPT names most often in answers about a keyword or domain, each with mention count, AI search volume, and the sources and categories behind them as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of brands to return. You are billed per returned result, so a lower limit costs less. | |
| domain | No | Only count AI answers that mention or cite this domain, without a protocol or leading www. Send domain or keyword, not both. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| keyword | No | Only count AI answers that contain this word or phrase. Send domain or keyword, not both. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code to restrict answers to, for example en. Omit for every language. | |
| location | No | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| breakdownLimit | No | How many entries each breakdown list (cited domains, brands, locations, and so on) carries. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_llm_top_domainsSEO LLM Top DomainsInspect
Rank the domains Google AI Overviews and ChatGPT cite most often in answers about a keyword or domain, each with mention count, AI search volume, and breakdowns by platform, location, and co-cited sources as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of domains to return. You are billed per returned result, so a lower limit costs less. | |
| domain | No | Only count AI answers that mention or cite this domain, without a protocol or leading www. Send domain or keyword, not both. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| keyword | No | Only count AI answers that contain this word or phrase. Send domain or keyword, not both. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code to restrict answers to, for example en. Omit for every language. | |
| location | No | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. | |
| platform | No | AI surface to count: google for Google AI Overviews, chat_gpt for ChatGPT. Omit for both. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| breakdownLimit | No | How many entries each breakdown list (cited domains, brands, locations, and so on) carries. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_llm_top_pagesSEO LLM Top PagesInspect
Rank the pages Google AI Overviews and ChatGPT cite most often in answers about a keyword or domain, each with mention count, AI search volume, and breakdowns by platform, location, and co-cited sources as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of pages to return. You are billed per returned result, so a lower limit costs less. | |
| domain | No | Only count AI answers that mention or cite this domain, without a protocol or leading www. Send domain or keyword, not both. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| keyword | No | Only count AI answers that contain this word or phrase. Send domain or keyword, not both. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code to restrict answers to, for example en. Omit for every language. | |
| location | No | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. | |
| platform | No | AI surface to count: google for Google AI Overviews, chat_gpt for ChatGPT. Omit for both. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| breakdownLimit | No | How many entries each breakdown list (cited domains, brands, locations, and so on) carries. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_local_packGoogle Local PackInspect
Get the Google local pack for a keyword in a city: the short list of businesses Google shows in the map box on its normal search results page, in pack order, with rating, review count, address, category, opening hours, phone, website, booking link, and Google listing ids. Sponsored listings are left out. For the full Google Maps results list, use maps.search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of local pack businesses to return. Google usually shows three. Billing is flat per request. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| keyword | Yes | Search keyword, for example coffee shop or plumber. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code for the search results. | |
| location | Yes | Location to search from, formatted like City,Region,Country; for example, New York,New York,United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `address` or `cid`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a business that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_ranked_keywordsSEO Ranked KeywordsInspect
Get AnyAPI SEO ranked keywords for a domain with rankings, traffic estimates, volume, CPC, difficulty, and intent as normalized JSON. One call returns up to 1,000 keywords; use offset to page further. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of ranked keywords to return. 1,000 is the per-call maximum; use offset to fetch more. You are billed per returned result, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Number of ranked keywords to skip in the chosen sort order. To fetch the next page, set offset to the previous offset plus limit, and keep the same orderBy, location, and language across pages. You are billed only for the keywords returned. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| target | Yes | Domain to analyze, without a protocol or leading www. | |
| orderBy | No | Sort order for the returned ranked keywords: by SERP position (ascending for best rankings first), search volume, or estimated traffic value (etv). Omit for the default order. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language code for SEO ranking metrics. | |
| location | No | Location code for SEO ranking metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_search_intentSEO Search IntentInspect
Classify AnyAPI SEO keyword search intent as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| keywords | Yes | SEO keywords to classify by search intent. | |
| language | No | Language code for search intent classification. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_seo_search_volumeSEO Search VolumeInspect
Get AnyAPI SEO keyword search volume, CPC, competition, bid estimates, and monthly history as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| dateTo | No | End of the historical monthly-searches window, formatted YYYY-MM-DD. Omit for the default trailing window. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| dateFrom | No | Start of the historical monthly-searches window, formatted YYYY-MM-DD. Cannot be more than four years before today. Omit for the default trailing window. | |
| keywords | Yes | SEO keyword phrases to retrieve search-volume metrics for. | |
| language | No | Language code for SEO search-volume metrics. | |
| location | No | Location code for SEO search-volume metrics. The default is the United States. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| searchPartners | No | When true, include Google search-partner network volume in the reported numbers; when false (the default), count Google search only. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_snapchat_profileSnapchat ProfileInspect
Fetch a Snapchat user's public profile by username: display name, bio, subscriber count, and recent public content. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The Snapchat username or profile URL to look up (e.g. fcbarcelona or https://www.snapchat.com/add/fcbarcelona). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_social_finderSocial Profile FinderInspect
Find a person's or brand's profiles across major social networks from a single name, returned as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| name | Yes | The profile name or handle to search for across social networks (e.g. johndoe). | |
| limit | No | Maximum number of results to return (1-10, default 10). You are billed per result returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| platform | No | Limit the search to one network: askfm, discord, facebook, github, instagram, linkedin, medium, pinterest, steam, threads, tiktok, twitch, or youtube (e.g. instagram); all networks are searched when omitted. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_spotify_albumSpotify AlbumInspect
Fetch a Spotify album's tracklist, play counts, label, and release details by album URL or ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify album ID (alternative to url). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Spotify album URL (e.g. https://open.spotify.com/album/0pgrg7phBbnwGJ2HBEl9EG). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_spotify_artistSpotify ArtistInspect
Fetch a Spotify artist's discography (albums, singles, top tracks) and metadata by artist URL or ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify artist ID (alternative to url). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Spotify artist URL (e.g. https://open.spotify.com/artist/3DiDSECUqqY1AuBP8qtaIa). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_spotify_podcastSpotify PodcastInspect
Fetch a Spotify podcast show's name, publisher, description, rating, and topics by show URL or ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify podcast show ID (alternative to url). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Spotify podcast show URL (e.g. https://open.spotify.com/show/3mliji9352UAk3XnWElnDV). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_spotify_podcast_episodesSpotify Podcast EpisodesInspect
List a Spotify podcast show's episodes with titles, durations, descriptions, and release dates by show URL or ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify podcast show ID (alternative to url). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Spotify podcast show URL (e.g. https://open.spotify.com/show/4rOoJ6Egrf8K2IrywzwOMk). | |
| cursor | No | Pagination cursor from a previous response for subsequent pages. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_spotify_searchSpotify SearchInspect
Search Spotify for matching tracks, albums, artists, podcasts, and playlists by keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Search term (e.g. "my first million"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_spotify_trackSpotify TrackInspect
Fetch a Spotify track's play count, popularity, duration, and album details by track URL or ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify track ID (alternative to url). | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Spotify track URL (e.g. https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_substack_postsSubstack PostsInspect
Pull posts from any Substack publication by its URL, or pass a single post URL (…/p/slug) to fetch just that one article. Returns title, subtitle, publish date, paywall status, word count, engagement (reactions, comments, restacks), author profile, publication details, the full article body as text, HTML and Markdown, and optional comment threads. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Either a Substack publication URL / custom domain to fetch its recent posts (e.g. https://www.astralcodexten.com), OR a single post URL to fetch just that one article with full content (e.g. https://www.astralcodexten.com/p/your-book-review). | |
| limit | No | Maximum number of recent posts to return when given a publication URL (1-100, default 25); ignored for a single post URL, which always returns that one post. You are billed per post returned, so a lower limit costs less. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| endDate | No | Only return posts published on or before this date, format YYYY-MM-DD (e.g. 2024-12-31). Applied within the most recent 'limit' posts scanned. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| onlyFree | No | Return only free (non-paywalled) posts (e.g. true). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Only return posts published on or after this date, format YYYY-MM-DD (e.g. 2024-01-01). Applied within the most recent 'limit' posts scanned, so raise 'limit' to reach older date ranges. | |
| contentType | No | Restrict to a single post type, or 'all' (e.g. newsletter). | |
| maxComments | No | Maximum comments collected per post when 'includeComments' is true (0-500, default 20). Costs nothing extra (e.g. 50). | |
| minComments | No | Only return posts with at least this many comments (e.g. 10). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| minReactions | No | Only return posts with at least this many reactions (e.g. 100). | |
| minWordCount | No | Only return posts with at least this many words, which filters out short notes and announcements (e.g. 1000). | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| includeContent | No | Include the full article body as text, HTML and Markdown. Set false for metadata only, which is faster (e.g. false). | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeComments | No | Include public comment threads and their direct replies on each post (e.g. true). | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_technographics_theirstackTechnographics - TheirStackInspect
Read the technology stack TheirStack detects for a company from its job posts, with how many posts mention each technology, when it was first and last seen, and how dominant it is within its category. Billed per technology returned. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Page number. Required when using page-based pagination. | |
| limit | No | Rows to return on this page, up to TheirStack's maximum of 500. Every row returned is billed. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Number of results to skip. Required for offset-based pagination. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| maxJobs | No | Maximum number of jobs found by each company using a technology | |
| maxRank | No | The rank measures how common is a technology within its category. The technology most used among similar ones by a company will have a rank of 1, the second: 2, etc. This is useful to filter results by technology and get only results for the primary technology. | |
| minJobs | No | Minimum number of jobs found by each company using a technology | |
| orderBy | No | List of column objects. You can pass several columns to order by, in order of priority. Only `field` is required, `desc` is True by default. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| companyId | No | companyId | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| companyName | No | Only return companies that match this name exactly, case-sensitively. | |
| confidenceOr | No | Returns technologies with any of these confidence values that the companies use them. Available values: "high", "medium", "low" | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| companyDomain | No | Only return companies that match this domain exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). | |
| companyNameOr | No | Only return companies that match these names exactly, case-sensitively. Deprecated, use the `company_name` filter instead. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| keywordSlugOr | No | Return companies that have mentioned any of these keywords (technologies or buying intent topics) in their jobs. Case sensitive. Pass slugs. Check out all keywords at GET /v0/catalog/keywords | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| lastDateFoundGte | No | Only return technologies where the last time they were found was after or on this date. Format: "YYYY-MM-DD" | |
| lastDateFoundLte | No | Only return technologies where the last time they were found was before or on this date. Format: "YYYY-MM-DD" | |
| technologySlugOr | No | Deprecated: use `keyword_slug_or` instead. Will return companies that have mentioned any of these technologies in their jobs. Case sensitive. Pass slugs. | |
| firstDateFoundGte | No | Only return technologies where the first time they were found was after or on this date. Format: "YYYY-MM-DD" | |
| firstDateFoundLte | No | Only return technologies where the first time they were found was before or on this date. Format: "YYYY-MM-DD" | |
| companyLinkedinUrl | No | Return companies whose LinkedIn URL matches this URL exactly. | |
| includeTotalResults | No | When enabled, calculates and returns `total_results` and `total_companies` fields in the response. WARNING: This significantly slows down responses as it requires reading the entire dataset. Recommended usage: enable only for the initial request to get totals, then disable for subsequent pagination requests. | |
| companyKeywordSlugOr | No | Return companies that have mentioned any of these keywords (technologies or buying intent topics) in their jobs. Case sensitive. Pass slugs. Check out all keywords at GET /v0/catalog/keywords | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| keywordCategorySlugOr | No | Return companies that have mentioned any keyword from any of these categories in their jobs. Case sensitive. Pass slugs. Check out all keyword categories at GET /v0/catalog/keywords/categories | |
| minRelativeOccurrence | No | Minimum value of relative_occurrence_within_category for each technology. Higher values increase the probability that this technology is actually used by the company, because it means a higher percentage of mentions to technologies among this category are of this technology. | |
| companyTechnologySlugOr | No | Return companies that have mentioned any of these keywords (technologies or buying intent topics) in their jobs. Case sensitive. Pass slugs. Check out all keywords at GET /v0/catalog/keywords | |
| technologyCategorySlugOr | No | Deprecated: use `keyword_category_slug_or` instead. Will return companies that have mentioned any keyword from any of these categories in their jobs. Case sensitive. Pass slugs. | |
| keywordParentCategorySlugOr | No | Return companies that have mentioned any keyword from any of these parent categories in their jobs. Case sensitive. Pass slugs. Check out all keyword categories at GET /v0/catalog/keywords/categories | |
| technologyParentCategorySlugOr | No | Deprecated: use `keyword_parent_category_slug_or` instead. Will return companies that have mentioned any keyword from any of these parent categories in their jobs. Case sensitive. Pass slugs. |
anyapi_post_v1_run_threads_postThreads PostInspect
Fetch a single Threads post by URL: text, author, engagement counts, and timestamp. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The full URL of the Threads post to fetch (e.g. https://www.threads.com/@zuck/post/C8yKXdRxKqK). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_threads_profileThreads ProfileInspect
Fetch a Threads user's public profile (bio, follower count, verification, profile picture) by username. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The Threads username to look up, without the @ prefix (e.g. zuck). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_threads_searchThreads SearchInspect
Search public Threads posts by keyword or hashtag and get normalized post records: text, author, and engagement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Keyword or hashtag to search public Threads posts for; the # prefix is optional (e.g. AI agents). Threads matches text in posts, so search a brand or topic rather than a URL - a query that is only a domain is searched by its name (wander.com is searched as wander). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| endDate | No | Only return posts published on or before this date, format YYYY-MM-DD (e.g. 2026-08-07). Threads pages backwards in time from here, so narrowing this is how you walk older results. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Only return posts published on or after this date, format YYYY-MM-DD (e.g. 2026-08-01). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_threads_search_usersThreads User SearchInspect
Search Threads users by name or username and get normalized profile records: username, full name, verification, and picture. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The name or username to search Threads users for. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_threads_user_postsThreads User PostsInspect
List a Threads user's recent public posts by username: text, engagement counts, and post URLs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | The Threads username to list posts for, without the @ prefix. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_ad_library_adTikTok Ad Library AdInspect
Fetch full details for a single TikTok ad (brand, title, spend, CTR, objectives, landing page, and video info). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| adId | Yes | TikTok Top Ads material/ad ID, or a Top Ads detail URL (e.g. 7648493525660270600). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_ad_library_searchTikTok Ad Library SearchInspect
Search TikTok's public Ads Library by keyword or advertiser (advertiser, title, audience band, run dates, library link, and video). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | No | Keyword to search ad titles and content (e.g. spotify). Provide query or advertiserName, never both. | |
| cursor | No | Opaque cursor from a previous response's nextCursor. Omit it for the first page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | Two-letter region code for TikTok's Commercial Content Library, such as DE, FR, GB or IT. Each region holds a different set of ads. Omit it to take the library's own default region, DE. Coverage is the EU and EEA; a non-EU code such as US is not served. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| advertiserName | No | Advertiser name to list ads for (e.g. Spotify). Provide advertiserName or query, never both. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_ad_transparency_searchTikTok Ad Transparency SearchInspect
Search TikTok's EU Commercial Content Library by keyword or advertiser ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| days | No | Number of days of Commercial Content Library history to search, from 1 to 365. Defaults to 30. | |
| sort | No | Upstream sort expression. Defaults to last_shown_date,desc. | |
| limit | No | Maximum number of ads to return, from 1 to 50. Defaults to 20. Billing is flat per request. | |
| query | No | Keyword to search in TikTok's EU Commercial Content Library. Provide query or advertiserId. | |
| cursor | No | Search cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Zero-based result offset. Defaults to 0. | |
| region | No | Region code for the transparency search. Defaults to DE. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| advertiserId | No | TikTok Commercial Content Library advertiser ID. Provide advertiserId or query. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_audience_demographicsTikTok Audience DemographicsInspect
Get the audience country breakdown (follower count and share per country) for a TikTok creator by handle. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok username without the leading @ (e.g. "shakira"). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_comment_repliesTikTok Comment RepliesInspect
List the replies to a TikTok comment with cursor pagination (text, author, likes). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | TikTok video URL the comment belongs to. | |
| cursor | No | Pagination cursor from a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| commentId | Yes | TikTok comment ID (the comment's cid from the comments endpoint). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `authorUserId`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a reply that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_followersTikTok FollowersInspect
List the followers of a TikTok account by username, returning each follower's profile basics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response's nextCursor, to fetch the next page of followers. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok username whose followers to list, without the @ prefix (e.g. stoolpresidente). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `videoCount` or `secUid`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a follower that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_followingTikTok FollowingInspect
List the accounts a TikTok user follows (handle, display name, follower count, bio) by username. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination cursor from a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok username without the leading @ (e.g. "stoolpresidente"). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireCursor | No | Deprecated; send `requireFields: ["nextCursor"]` instead, which does exactly the same thing. Set true if you intend to page through results, so the request is only served by a source that can return a nextCursor. Omit it and routing is unchanged, with the cheapest source serving. This can raise your price: when the cheapest source cannot page, a source that can serves, and you are quoted and charged its price. It stays accepted so callers that already send it keep working. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `secUid` or `instagramUrl`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_hashtag_videosTikTok Hashtag VideosInspect
List recent TikTok videos for a hashtag (creator, caption, views, likes, shares). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of videos. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| hashtag | Yes | TikTok hashtag to fetch videos for, without the # prefix (e.g. booktok). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `playCount`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a video that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. A source that returns only a rounded or shortened value for a field does not count as returning it. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_liveTikTok LiveInspect
Check whether a TikTok creator is live and get the current live room (title, viewers, start time) by handle. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok username without the leading @ (e.g. "thejustalex"). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_photosTikTok PhotosInspect
Get every image in a TikTok photo-mode (slideshow) post by URL, in order, with pixel dimensions and both the clean and watermarked variant of each. Videos carry no images - use tiktok.video_download for those. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full TikTok photo-mode post URL. TikTok serves slideshow posts under the same /video/<id> path as videos, so the normal share link works. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `authorFollowers`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_playlist_videosTikTok Playlist VideosInspect
List the videos inside one TikTok playlist by playlist URL or id, in playlist order, with view, like and comment counts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | TikTok playlist id. Use it when tiktok.profile_playlists handed you the id. | |
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | No | Full TikTok playlist URL. The playlist id is the numeric run at the end. | |
| limit | No | Maximum items to return in one page. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_profileTikTok ProfileInspect
Fetch a TikTok creator's public profile (followers, likes, bio, verification) by handle. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok username without the leading @ (e.g. "stoolpresidente"). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `createdUtc`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on an account that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_profile_contactTikTok Profile Contact InfoInspect
Find the public contact email behind a TikTok creator's profile: the address written into the bio plus any published on the site the profile links to, each labelled with where it came from. Returns the creator's profile stats and linked social accounts alongside. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok username without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `domain` or `sourceUrl`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_profile_playlistsTikTok Profile PlaylistsInspect
List the playlists a TikTok creator has published on their profile, with each playlist's name, video count and cover image. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum items to return in one page. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| secUid | Yes | TikTok's opaque sec_uid for the account. TikTok's own endpoint keys on it and will not accept a handle; call tiktok.profile with the handle first and read secUid off its response. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_profile_regionTikTok Profile RegionInspect
Resolve the home region (country) of a TikTok creator by handle. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok username without the leading @ (e.g. "stoolpresidente"). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_profile_repostsTikTok Profile RepostsInspect
List the videos a TikTok creator has reposted to their profile, with view, like and comment counts and cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum items to return in one page. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| secUid | Yes | TikTok's opaque sec_uid for the account. TikTok's own endpoint keys on it and will not accept a handle; call tiktok.profile with the handle first and read secUid off its response. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_search_hashtagTikTok Hashtag SearchInspect
Search TikTok by hashtag and get matching videos (caption, views, likes, comments, shares) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Hashtag or keyword to search for (without the leading #). | |
| cursor | No | Pagination cursor from a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `soundTitle` or `locationName`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a video that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_search_photosTikTok Photo SearchInspect
Search TikTok for photo-mode (slideshow) posts by keyword, with every image in each post plus view, like and comment counts. tiktok.search_keyword returns videos and drops these. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum items to return in one page. | |
| query | Yes | Search keyword. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_search_suggestionsTikTok Search SuggestionsInspect
Get the search terms TikTok suggests for a keyword, each with its language and relative weight - the queries real TikTok users type around your topic. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Seed keyword to expand. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_search_topTikTok Top SearchInspect
Search TikTok's top results for a keyword (caption, views, likes, comments, shares) with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Keyword to search for (e.g. "funny"). | |
| cursor | No | Pagination cursor from a previous response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | 2-letter country code for the proxy location (e.g. US, GB, FR). | |
| sortBy | No | Sort order: relevance, most-liked, date-posted. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| publishTime | No | Time-frame filter: yesterday, this-week, this-month, last-3-months, last-6-months, all-time. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `soundClipId` or `nextCursor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a record that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_search_usersTikTok User SearchInspect
Search TikTok accounts by keyword (handle, nickname, follower count) with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The keyword to search TikTok accounts for. | |
| cursor | No | Pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `secUid` or `bio`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a record that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_categoriesTikTok Shop CategoriesInspect
List the TikTok Shop category tree for a market: top-level categories with ids, slugs, and images, each with its child categories. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | Country code of the TikTok Shop market whose category tree to list. Only US and VN publish a category tree. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_creatorTikTok Shop CreatorInspect
TikTok Shop creator performance by handle: GMV range, promoted product count, brand collaborations, follower age/gender/location demographics, category GMV split, and video versus live engagement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | TikTok handle of the creator or shop account, without the @ (e.g. golinutrition). | |
| region | No | Country code of the TikTok Shop market. Only the US market is served; creators in other markets are not available. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_productTikTok Shop ProductInspect
Fetch TikTok Shop product details (title, price, sales, seller, and ratings) from a product URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | TikTok Shop product detail page URL (e.g. https://www.tiktok.com/shop/pdp/.../1729587769570529799). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | Two-letter country code for the proxy location used to access region-specific products (e.g. US, GB, FR). Defaults to US. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `sellerLocation`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_product_reviewsTikTok Shop Product ReviewsInspect
Fetch customer reviews for a TikTok Shop product by URL (rating, text, reviewer, country, and verified-purchase flag). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | TikTok Shop product URL (e.g. https://www.tiktok.com/shop/pdp/.../1729385633899532161). | |
| page | No | 1-based results page. Use with hasMore in the output to paginate. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | Two-letter country code of the product's shop region (e.g. US). Strongly recommended for correct results. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `images`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be empty on a review that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_searchTikTok Shop SearchInspect
Search TikTok Shop products by keyword across 15 countries: price, sales, rating, and seller info per product, in one normalized response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum products to return, honoured on US searches up to 30. Other countries and larger values return every product TikTok Shop gives for the query, typically about 30 and occasionally more than 50. The price per call is the same either way. | |
| query | Yes | Search keyword for TikTok Shop products (e.g. wireless earbuds). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | Country code of the TikTok Shop market to search (e.g. US). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `currency`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_search_suggestionsTikTok Shop Search SuggestionsInspect
Get TikTok Shop search autocomplete terms for a keyword: the long-tail queries shoppers actually type, for keyword and demand research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Seed keyword to expand (e.g. ashwagandha gummies). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| country | No | Two-letter country code of the TikTok Shop market (e.g. US). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Language tag for the suggestions (e.g. en-US). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_shop_productsTikTok Shop Store ProductsInspect
List every product of a TikTok Shop store by URL (title, price, sales, and rating per product plus shop-level stats) with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | TikTok Shop store URL (e.g. https://www.tiktok.com/shop/store/...). | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | No | Two-letter country code of the store's market (e.g. US). | |
| sortBy | No | Product ordering within the store. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `shopRating`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a store that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_shop_user_showcaseTikTok Shop User ShowcaseInspect
List the TikTok Shop products a creator showcases (title, price, rating, and sales per product). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Pagination token for retrieving subsequent product pages. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | The handle of the TikTok user (e.g. mrtiktokreviews). | |
| region | No | Geographical region for proxy placement (defaults to US). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_songTikTok SongInspect
Fetch details for a TikTok song or sound (title, author, duration, cover art, and how many videos use it). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| clipId | Yes | The clip identifier for the song, found in TikTok music URLs (e.g. 7439295283975702544). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_song_videosTikTok Song VideosInspect
List TikTok videos that use a given song or sound (with descriptions, authors, and engagement stats). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| clipId | Yes | The song ID found in TikTok music URLs (e.g. 7439295283975702544). | |
| cursor | No | Pagination cursor for retrieving the next page of results. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a record that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_top_ads_searchTikTok Top Ads SearchInspect
Search TikTok Creative Center top video ads by keyword, with campaign objective, performance percentile, and time-window filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | One-based provider page number (default 1). | |
| limit | No | Maximum number of ads requested for this page, from 1 through 20 (default 20). | |
| query | Yes | Keyword to search in TikTok Creative Center top video ads. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| period | No | Lookback period in days (default 180). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| objective | No | Campaign objective filter. Omit it to search every objective. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| performanceRank | No | Ad performance percentile bucket, where top_1_20 is the highest-performing 20 percent. Omit it to search every bucket. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_trending_feedTikTok Trending FeedInspect
Sample TikTok's For You feed as served to a viewer in one country (caption, views, likes, comments, author). Returns a rotating sample, not a ranked chart. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| trim | No | Set to true to return a simplified response. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| region | Yes | 2-letter country code for the proxy location (e.g. "US"). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_trending_hashtagsTikTok Trending HashtagsInspect
Rank TikTok's trending hashtags for one country and industry, with each hashtag's daily popularity curve, post count, video views, and leading creators. Ranks 15 industry categories, or omit industry for the all-industries board. TikTok publishes only the top 3 hashtags per board to anonymous callers, so limit 1-3 is served cheaply; a limit above 3 routes to a dearer authenticated source that returns the full ranking. Covers 27 markets: AE, AR, AU, BR, CA, CO, DE, EG, ES, FR, GB, ID, IL, IT, JP, KR, MX, MY, PH, SA, SG, TH, TR, TW, US, VN, ZA. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of ranked hashtags to return, from 1 through 100 (default 3). TikTok publishes only the top 3 hashtags per board to anonymous callers, so 1 through 3 is served by the cheapest source; a higher limit routes to a dearer source that reads the full ranking. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| period | No | Lookback window in days that the ranking and the popularity curve cover (default 7). | |
| region | No | Two-letter country code of the market whose hashtag ranking to read (default US). Each market is ranked independently, so US and DE return different boards. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| industry | No | Restrict the ranking to one industry. Omit for the all-industries board. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `industryIds`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a hashtag that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_video_downloadTikTok Video DownloadInspect
Get the playable media files behind a TikTok video URL: the clean no-watermark MP4, the watermarked one TikTok's own save button produces, and the cover image, with duration and pixel dimensions. Photo-mode posts carry no video file - use tiktok.photos for those. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full TikTok video URL. Share links and tracking query params are fine. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `height` or `width`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a video that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tiktok_video_transcriptTikTok Video Transcript (native captions)Inspect
Fetch the caption track TikTok itself published for a video, as TikTok wrote it. It is the cheapest way to get the words, and it is only as good as TikTok's own transcription: it mishears names and uncommon words, and many videos - especially non-English ones - have no caption track at all, which comes back as not found. When you need the words to be right, or there is no track to read, tiktok.video_transcript_full transcribes the audio with AnyAPI's own speech-to-text instead. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full TikTok video URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `language`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a video that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tripadvisor_reviewsTripadvisor ReviewsInspect
Fetch the latest reviews for any Tripadvisor hotel, restaurant, or attraction by its page URL: rating, text, date, and trip details as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Tripadvisor page URL of the hotel, restaurant, or attraction. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| since | No | Only return reviews newer than this date, YYYY-MM-DD or a relative window like '3 months' (e.g. 2026-01-01). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| ratings | No | Only return reviews whose bubble rating is in this set (e.g. ["5", "4"] for 4 and 5 star reviews); omit for all ratings. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| languages | No | Only return reviews in these ISO 639-1 languages (e.g. ["en", "es"]); omit for all languages. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_tripadvisor_searchTripadvisor SearchInspect
Search Tripadvisor for hotels, restaurants, and attractions in any destination and get rich place records (ratings, review counts, contact details, pricing) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-20, default 20). | |
| query | Yes | Destination or keyword to search for (e.g. Barcelona). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| currency | No | ISO currency code for prices (e.g. USD, EUR). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| includeHotels | No | Include hotels in the results; set false to exclude them (e.g. false). Defaults to true. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `phone` or `website`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a place that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeAttractions | No | Include attractions and things to do in the results; set false to exclude them (e.g. false). Defaults to true. | |
| includeRestaurants | No | Include restaurants in the results; set false to exclude them (e.g. false). Defaults to true. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_trustpilot_reviewsTrustpilot ReviewsInspect
Pull Trustpilot reviews for any company by brand name: star ratings, review text, dates, and reviewer details as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-200, default 200). Trustpilot serves at most 200 reviews per company. | |
| stars | No | Limit reviews to a single star rating from 1 to 5 (e.g. 5). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| sortBy | No | Review ordering: auto, relevancy, or recent (e.g. recent). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| company | Yes | Brand name or Trustpilot review-page URL to fetch reviews for (e.g. nike or https://www.trustpilot.com/review/nike.com). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| countries | No | Only return reviews from reviewers in these ISO 3166-1 alpha-2 countries (e.g. ["US", "GB"]). Omit this field for all countries and to stay on the cheapest price; a country filter routes to the dearest source. | |
| languages | No | Only return reviews in these ISO 639-1 languages (e.g. ["en", "de"]). Omit this field for all languages and to stay on the cheapest price; a language filter routes to the dearest source. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| startDate | No | Only return reviews on or after this date, inclusive, in YYYY-MM-DD format (e.g. 2026-01-01). Omit this field to stay on the cheapest price; a date floor routes to the dearest source. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| verifiedOnly | No | Set true to return only verified reviews (e.g. true). Omit this field, or send false, to stay on the cheapest price; true routes to a dearer source. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `avatarUrl`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a review whose reviewer has no photo. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_truthsocial_postTruth Social PostInspect
Get a single Truth Social post by its URL - text, author, engagement (likes, comments, shares), and timestamp as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full Truth Social post URL, e.g. "https://truthsocial.com/@realDonaldTrump/posts/116824551176646175". | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_truthsocial_profileTruth Social ProfileInspect
Get a Truth Social account's public profile by handle - display name, bio, follower/following counts, and post count as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Truth Social handle without the @, e.g. "realDonaldTrump". | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_truthsocial_user_postsTruth Social User PostsInspect
List a Truth Social account's recent posts by handle - text, engagement (likes, comments, shares), and timestamps as clean JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; a page holds 20 posts. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Truth Social handle without the @, e.g. "realDonaldTrump". | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_articleX / Twitter ArticleInspect
Get a public X long-form article from its wrapper post URL, including its author, engagement, cover image, and structured content blocks. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Canonical x.com or twitter.com URL of the public wrapper post for an X Article. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_communityTwitter CommunityInspect
Fetch a Twitter/X community's public details (name, description, member count, join policy) by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Community URL (e.g. https://x.com/i/communities/1926186499399139650). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_community_tweetsTwitter Community TweetsInspect
List recent tweets posted in a Twitter/X community by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Community URL (e.g. https://x.com/i/communities/1926186499399139650). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_followersX / Twitter FollowersInspect
Fetch the follower list of any public X (Twitter) account by username with cursor pagination. Limit is a per-page maximum and a native page holds up to 200 accounts; follow the response's nextCursor for more. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Accepted but does not change the page: every call returns one full native page of followers (up to 200, depending on the source), never trimmed, so follow nextCursor to continue exactly where this response ended. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of followers. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The X (Twitter) username to fetch followers for, without the @ prefix (e.g. elonmusk). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `bio`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_followingX / Twitter FollowingInspect
List the accounts a public X (Twitter) account follows by username with cursor pagination. Limit is a per-page maximum; follow the response's nextCursor for more. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Accepted but does not change the page: every call returns one full native page of followed accounts (about 50), never trimmed, so follow nextCursor to continue exactly where this response ended. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of followed accounts. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| username | Yes | The X (Twitter) username to fetch the following list for, without the @ prefix (e.g. elonmusk). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `location`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_profileTwitter ProfileInspect
Fetch a Twitter/X account's public profile (followers, tweets, bio, verification) by handle. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Twitter/X handle without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_repliesX / Twitter Post RepliesInspect
Fetch the replies to any X (Twitter) post URL as structured records: author, text, and engagement. An empty result is valid and does not assert whether the target post exists. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full URL of the X (Twitter) post to fetch replies for (e.g. https://x.com/nasa/status/1846987139428634858). | |
| limit | No | Maximum number of results to return (1-40, default 40). Per-result lanes cost less at lower limits; a backup that bills its native page may cost up to the advertised request price. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of replies. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_searchX / Twitter SearchInspect
Search X (Twitter) with full advanced-search syntax (operators like from:, since:, until:, min_faves: work inline in the query) and get structured tweets with text, author, engagement, and cursor pagination. Limit is a per-page maximum; native pages contain approximately 20 tweets unless requireSinglePage selects a bulk lane. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Page size to ask for (1-50, default 20). Some sources honor it; others always return their whole native page of about 20. A page is never trimmed after the call, so follow nextCursor to continue exactly where this response ended. | |
| query | Yes | Search query using X (Twitter) advanced-search syntax. IMPORTANT: bare terms are ANDed - a tweet must contain EVERY word, so a list of loosely related keywords matches nothing; use one short phrase or OR between alternatives (e.g. 'anyapi OR getanyapi'). When an operator follows an OR list, put the list in parentheses, e.g. '(anyapi OR getanyapi) -filter:replies': without them X applies the operator to the last alternative only, so such a query still runs as X reads it and the response's hint carries the corrected query. You can embed X advanced-search operators directly in the query to filter results: from:username and to:username (author or recipient), since:YYYY-MM-DD and until:YYYY-MM-DD (date range), min_faves:N, min_retweets:N, min_replies:N (engagement floors), "exact phrase", -term to exclude, filter:media and filter:links and -filter:replies (content filters), lang:en, near:city, and geocode:lat,long,radius. Examples: 'from:OpenAI', 'AI agents min_faves:500 -filter:replies', 'nvidia since:2026-01-01 until:2026-03-01'. A query with no matches returns an empty items array; prefer the fewest words that identify the topic. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of search results. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| queryType | No | Which posts to return: 'Latest' (newest first, the default), 'Top' (most popular), 'Photos' (newest posts with images), or 'Videos' (newest posts with video). Photos and Videos search your query as written with filter:images or filter:videos added after it, so they cost the same as a Latest search. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| requireSinglePage | No | Set true to get up to limit results in one response instead of provider-native pages, served by a bulk provider when needed. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_search_usersX / Twitter User SearchInspect
Search X (Twitter) accounts by keyword - the People tab of X search. Matches handles, display names, and profile bios, and returns normalized profile records with follower, following, and post counts plus cursor pagination. Use twitter.search for posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | Keyword to match against X (Twitter) handles, display names, and profile bios. This is the People tab of X search: pass a topic ('ai agents'), a name ('Elon Musk'), or a handle ('openai') and get back accounts, not posts. Use twitter.search for posts. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of accounts. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `location`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_threadX / Twitter Tweet ThreadInspect
Resolve the linear self-thread containing an X (Twitter) post, from its root through the author's linked continuations. This excludes replies from other users. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Canonical x.com or twitter.com status URL with a numeric tweet ID. Any tweet in the self-thread can be supplied; the provider resolves the thread root. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_trendsX / Twitter TrendsInspect
Get current X (Twitter) trends for worldwide, a country, or a city in X ranking order, including the resolved location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of ranked trends to return (1-50, default 50). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Country name, city name, or ISO country code. Omit for worldwide trends. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `promoted`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a trend that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_tweetTwitter TweetInspect
Fetch a single Twitter/X tweet by URL with its full text and engagement counts (likes, retweets, replies, quotes, bookmarks, views). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Canonical x.com or twitter.com status URL with a numeric tweet ID, including /i/web/status and media-share variants. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `videoUrl` or `width`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a tweet that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_tweet_transcriptTwitter Tweet TranscriptInspect
Extract the spoken transcript from a Twitter/X video tweet by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Tweet URL of the video to transcribe (e.g. https://x.com/TheoVon/status/1916982720317821050). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_twitter_user_postsX / Twitter User PostsInspect
Get an X (Twitter) account's profile Posts-tab timeline by handle. Results follow profile order: a pinned post may appear first, followed by otherwise reverse-chronological authored posts, reposts, quotes, and self-thread continuations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | Yes | Twitter/X handle without the leading @. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `isPinned`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a tweet that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_upwork_jobsUpwork JobsInspect
Search Upwork job postings by keyword, with up to 25 fresh listings per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Sort order for listings: newest or relevance (e.g. newest). | |
| limit | No | Maximum number of results to return (10-25, default 25). | |
| query | Yes | Keywords to search Upwork jobs for (e.g. react developer). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| jobType | No | Filter by payment type: fixed-price or hourly jobs. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | No | Filter by client location - a region, subregion, or country (e.g. United States, Europe). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `premium` or `reposted`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a job that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| experienceLevel | No | Filter by required experience level. | |
| paymentVerified | No | When true, only return jobs from clients with a verified payment method. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_walmart_productWalmart ProductInspect
Fetch a Walmart product page by URL and get full product details (title, price, availability, ratings, images, and specs) in one normalized response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Walmart product page URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `productId`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_web_mapWeb MapInspect
Map an entire website into a clean list of its URLs (with titles and descriptions) in a single call. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The base URL of the site to map into a list of links. | |
| limit | No | Maximum number of links to return. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| search | No | Optional term that orders the returned links by relevance. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| sitemap | No | How to use the site's sitemap.xml when discovering URLs. 'include' (upstream default) merges sitemap URLs with links found by crawling; 'only' returns just the URLs listed in the sitemap (fastest and most authoritative); 'skip' ignores the sitemap and discovers URLs by crawling links. Omit to use 'include'. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeSubdomains | No | When true (upstream default), include URLs on subdomains of the target (for example docs.example.com when mapping example.com). Set false to return only URLs on the exact host. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_web_scrapeWeb ScrapeInspect
Scrape any web page and get its content back as clean Markdown (or HTML, or raw HTML) plus title and metadata. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The full web address of the page to scrape, including its domain, for example https://example.com. The https:// prefix is optional. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| mobile | No | When true, render the page with a mobile viewport and user agent instead of desktop. Some sites serve materially different content to mobile. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| formats | No | Which representations of the page to return. Any combination of: markdown (page content as Markdown), html (the page HTML exactly as the browser received it, including head and script tags). Each requested format is returned under the matching output field. Defaults to both. rawHtml is a deprecated alias of html, returned under a rawHtml field for callers that predate the rename; send html instead. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| waitFor | No | Milliseconds to wait for the page to finish rendering before capture. Use this for JavaScript-heavy pages or single-page apps whose content loads after the initial paint. Capped at 15000 to stay within the request timeout. This wait is time you asked us to spend, so your response takes this much longer, and it is excluded from the latency published for this endpoint. If every provider that can wait fails, the page may still be returned, captured without the wait. | |
| blockAds | No | When true (upstream default), strip ad and cookie-consent elements before capture. Set false to keep them. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| excludeTags | No | CSS selectors to drop before capture (for example ["nav", "footer", ".ads"]). Applied after includeTags. | |
| includeTags | No | CSS selectors to keep. When set, only content matching these selectors is captured (for example ["article", "main"] or ["#content"]). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `statusCode`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a record that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. A source that reports a field only in some cases, such as only when the website answered with an error, does not count as returning it. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| onlyMainContent | No | When true, return only the main article content, stripping navigation, headers, footers, and other boilerplate. Defaults to false to capture the full page. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_web_screenshotWebsite ScreenshotInspect
Capture a real-browser screenshot of any web page URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | The full URL of the page to capture. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| viewportWidth | No | Browser viewport width in pixels (e.g. 1280). | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_weibo_hot_searchWeibo Hot SearchInspect
Get the complete current Weibo hot-search ranking with labels and heat values. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_weibo_postWeibo PostInspect
Fetch a public Weibo post by ID with normalized author and engagement data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| postId | Yes | Weibo post identifier. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| includeLongText | No | Whether to include the full text of long posts. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_weibo_post_commentsWeibo Post CommentsInspect
List first-level comments on a public Weibo post with pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Requested comment count. | |
| cursor | No | Pagination cursor returned as nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| postId | Yes | Weibo post identifier. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_weibo_profileWeibo ProfileInspect
Fetch a public Weibo profile by user ID with normalized audience and account data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| userId | Yes | Weibo user identifier. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_weibo_searchWeibo Advanced SearchInspect
Search public Weibo posts with optional result, media, and time filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Page number starting at 1. | |
| query | Yes | Search keyword. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| timeScope | No | Custom time range in the API's custom:start:end format. | |
| searchType | No | Search type, such as all, hot, original, verified, media, or viewpoint. | |
| includeType | No | Media filter, such as all, pic, video, music, or link. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_weibo_user_postsWeibo User PostsInspect
List public posts from a Weibo user with normalized author and engagement data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| page | No | Page number starting at 1. | |
| cursor | No | Pagination identifier returned as nextCursor. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| userId | Yes | Weibo user identifier. | |
| feature | No | Response detail feature: 0 basic, 1 extended, 2 image-oriented, or 3 video-oriented. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_yelp_searchYelp SearchInspect
Search Yelp for businesses by keyword and location: up to 20 listings with ratings, categories, and core business info per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1 to 20, default 20). | |
| query | Yes | Search term or category to look for (e.g. sushi). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | Yes | City and state defining the search area (e.g. San Francisco, CA). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `is_closed` or `price`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a place that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_channel_playlistsYouTube Channel PlaylistsInspect
List a YouTube channel's playlists by handle or channel ID with cursor pagination (title, video count, thumbnail). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| cursor | No | Continuation token from a previous response for pagination. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| handle | No | YouTube channel handle. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| channelId | No | YouTube channel ID. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_comment_repliesYouTube Comment RepliesInspect
List replies to a YouTube comment using a continuation token with cursor pagination (text, author, likes, publish time). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| continuationToken | Yes | Replies continuation token from the comments endpoint, or the continuationToken from a previous replies response for further pagination. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_community_postYouTube Community PostInspect
Fetch a single YouTube community post by URL (text, images, channel, publish time). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | URL of the YouTube community post. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_playlistYouTube PlaylistInspect
List every video in a YouTube playlist (title, length, and channel per video plus playlist owner and totals). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| playlistId | Yes | The playlist ID: the "list" parameter in a playlist URL (e.g. "PLu0W_9lII9ahIappRPN0MCAgtOu3lQjQi"). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_searchYouTube SearchInspect
Search YouTube and get matching videos (title, channel, views, length, publish time) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The YouTube search query. | |
| cursor | No | Continuation token from a previous response for pagination. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| sortBy | No | Sort order: "relevance" (default) or "popular" (most-viewed). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| uploadDate | No | Filter by upload recency. Omit for any time. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireCursor | No | Deprecated; send `requireFields: ["nextCursor"]` instead, which does exactly the same thing. Set true if you intend to page through results, so the request is only served by a source that can return a nextCursor. Omit it and routing is unchanged, with the cheapest source serving. This can raise your price: when the cheapest source cannot page, a source that can serves, and you are quoted and charged its price. It stays accepted so callers that already send it keep working. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `nextCursor`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a result that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_search_hashtagYouTube Hashtag SearchInspect
Search YouTube videos by hashtag with cursor pagination (title, channel, views, length, publish time). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| type | No | Content filter. Only "all" is served: no source we buy returns a Shorts row with the channel and publish time this endpoint requires. | |
| cursor | No | Continuation token from a previous response for pagination. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| hashtag | Yes | Hashtag to search for (without the leading #). | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_search_shortsYouTube Shorts SearchInspect
Search YouTube Shorts by keyword and get matching Shorts (title, views, URL) with cursor pagination as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| query | Yes | The keyword to search Shorts for. | |
| cursor | No | Continuation token from a previous response for pagination. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| sortBy | No | Sort order: "relevance" (default) or "popular" (most-viewed). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| uploadDate | No | Filter by upload recency. Omit for any time. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_trending_shortsYouTube Trending ShortsInspect
List currently trending YouTube Shorts (title, channel, views, likes, duration). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_video_commentsYouTube Video CommentsInspect
List the comments on a YouTube video or Short by URL with cursor pagination (text, author, likes, reply count). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Full YouTube video URL. Shorts (youtube.com/shorts/...) and youtu.be URLs also work. | |
| order | No | Comment order (e.g. top, newest). | |
| cursor | No | Continuation token from a previous response for pagination. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `likes`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. On a paginated walk it applies to the first page only; later pages stay with the source that page chose, at the price it was quoted. A source that returns only a rounded value for a field does not count as returning it. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_video_sponsorsYouTube Video SponsorsInspect
Detect suspected sponsors and paid promotions in a YouTube video by URL (sponsor names, websites, confidence). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | YouTube video or Short URL. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | 2-letter language code for transcript lookup (e.g. en, es, fr). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_youtube_video_transcript_fullYouTube Video Transcript (Provenance)Inspect
Fetch a YouTube video or Short transcript with timed segments and its provenance: whether the words are creator-written captions or machine speech recognition. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | YouTube video or Short URL (e.g. "https://www.youtube.com/watch?v=dQw4w9WgXcQ" or "https://www.youtube.com/shorts/Fir1x9cw2vg"). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| language | No | Preferred caption language code (e.g. "en", "es"). Defaults to English. If the video has no captions in that language, you get the transcript in another language the video has; the `language` field in the result says which. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| captionKind | No | Which caption track to accept: "manual" only creator-written captions, "automatic" only YouTube's speech recognition, "any" whichever exists. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `isAiGenerated`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a transcript that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zhihu_answerZhihu AnswerInspect
Fetch a public Zhihu answer with normalized author and question data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| answerId | Yes | Zhihu answer identifier. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zhihu_profileZhihu ProfileInspect
Fetch a public Zhihu profile with normalized identity and audience data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| userToken | Yes | Zhihu user URL token. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zhihu_questionZhihu QuestionInspect
Fetch a public Zhihu question with normalized text and engagement statistics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| questionId | Yes | Zhihu question identifier. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zhihu_question_answersZhihu Question AnswersInspect
List the first page of public answers to a Zhihu question with normalized authors and engagement data. Pagination is not supported. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Number of answers requested on the first page. Pagination is not supported. | |
| order | No | Answer ordering: default ranking or recently updated. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| questionId | Yes | Zhihu question identifier. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zhihu_search_articlesZhihu Article SearchInspect
Search public Zhihu articles by keyword with normalized author and engagement data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| sort | No | Article ordering: comprehensive, most upvoted, or newest. | |
| limit | No | Number of articles requested per page. | |
| query | Yes | Search keyword. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| offset | No | Result offset returned as nextOffset in the previous response. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| searchHashId | No | Search hash identifier returned in the previous response. | |
| timeInterval | No | Optional publication-time filter. | |
| verticalInfo | No | Article-search vertical continuation state returned as nextVerticalInfo in the previous response. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| showAllTopics | No | Whether to include all topics: 0 excludes them and 1 includes them. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zillow_agentZillow AgentInspect
Fetch one Zillow real estate agent's profile by URL: name, phone, email, brokerage, rating, review count, sales, and service areas. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Zillow agent profile URL (e.g. https://www.zillow.com/profile/gregorycarlsonATX/). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zillow_propertyZillow PropertyInspect
Fetch full details for a single Zillow property listing by URL (price, facts and features, photos, and price/tax history). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| url | Yes | Zillow property details URL (e.g. https://www.zillow.com/homedetails/123-Main-St-Anytown-CA-90210/12345678_zpid/). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. |
anyapi_post_v1_run_zillow_searchZillow SearchInspect
Search Zillow for-sale, rental, or sold listings by region-level location (city, ZIP, county, or neighborhood) with optional price, bedroom, living-area, home-type, recency, and sort filters and get matching properties (price, address, beds, baths, living area, status, Zestimate) as normalized JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. | |
| limit | No | Maximum number of results to return (1-25, default 25). | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| sortBy | No | Sort order for results; omit for Zillow's default relevance. rentalPriorityScore applies to rent searches only (e.g. newest). | |
| source | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`. | |
| summary | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. | |
| location | Yes | Region-level location to search: ZIP code, city and state, county, or neighborhood (e.g. 'Austin, TX' or '78701'). Street addresses are not supported; use the property's ZIP code instead. | |
| maxPrice | No | Maximum price in USD: monthly rent for rentals, total price for buy/sold (e.g. 750000). | |
| minPrice | No | Minimum price in USD: monthly rent for rentals, total price for buy/sold (e.g. 250000). | |
| homeTypes | No | Filter by property type; omit for any. Rentals support only singleFamily, multiFamily, townhome, and condo (e.g. ["singleFamily", "condo"]). | |
| max_items | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. | |
| operation | No | Listing type: buy (for sale), rent, or sold. | |
| maxBedrooms | No | Maximum number of bedrooms (e.g. 5). | |
| minBedrooms | No | Minimum number of bedrooms (e.g. 3). | |
| daysOnZillow | No | Only include listings on Zillow at most this long (e.g. 1_week). | |
| listingTypes | No | Listing types to include for buy searches; omit for all standard types. fsba = agent listed, fsbo = for sale by owner. Ignored for rent and sold (e.g. ["newConstruction"]). | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| ignoreSources | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way. | |
| requireFields | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `yearBuilt`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a listing that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. | |
| allowFallbacks | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. | |
| Idempotency-Key | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. | |
| maxLivingAreaSqft | No | Maximum living area in square feet (e.g. 3000). | |
| minLivingAreaSqft | No | Minimum living area in square feet (e.g. 1500). | |
| includeRoomForRent | No | Include room-for-rent listings in rent searches; when omitted or false only entire places are returned (e.g. true). | |
| preferLatencyUnderMs | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. | |
| showOnlyPriceReductions | No | Only show listings with a price reduction. Buy searches only; ignored for rentals (e.g. true). | |
| includeAcceptingBackupOffers | No | Include listings accepting backup offers, which Zillow excludes by default (e.g. true). | |
| includePendingAndUnderContract | No | Include pending and under-contract listings, which Zillow excludes by default (e.g. true). |
blockrun_get_api_v1_commodity_listMarket Data — List Commodity SymbolsInspect
List available Commodity symbols from Pyth feeds. Free discovery endpoint. Supports q (search) and limit (max 2000) query params.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Optional substring filter on symbol or display name. | |
| limit | No |
blockrun_get_api_v1_commodity_price_symbolMarket Data — Commodity Spot PriceInspect
Current spot price for one Commodity symbol from Pyth Network. Symbol format: Commodity ticker BASE-QUOTE (e.g. XAU-USD for gold, WTI-USD for oil). Example: XAU-USD. Substitute the path tail with any valid symbol from /list.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | Asset symbol in the format verified for this operation. List coverage may exceed free price coverage; not every listed symbol can be queried. | |
| session | No | The web documentation and OpenAPI enums conflict. Free non-stock examples omit this parameter rather than choose an unverified enum. |
blockrun_get_api_v1_crypto_history_symbolMarket Data — Crypto OHLC HistoryInspect
Historical OHLC bars for one Crypto symbol. Symbol format: Crypto pair BASE-QUOTE (e.g. BTC-USD, ETH-USD, SOL-USD). Example: BTC-USD. Substitute the path tail with any valid symbol from /list.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End unix timestamp (seconds). Defaults to now. | |
| from | Yes | History start time in Unix seconds, not milliseconds. | |
| symbol | Yes | Asset symbol in the format verified for this operation. List coverage may exceed free price coverage; not every listed symbol can be queried. | |
| session | No | The web documentation and OpenAPI enums conflict. Free non-stock examples omit this parameter rather than choose an unverified enum. | |
| resolution | No | Bar resolution. Common values: 1, 5, 15, 60, 240, D, W. |
blockrun_get_api_v1_crypto_listMarket Data — List Crypto SymbolsInspect
List available Crypto symbols from Pyth feeds. Free discovery endpoint. Supports q (search) and limit (max 2000) query params.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Optional substring filter on symbol or display name. | |
| limit | No |
blockrun_get_api_v1_crypto_price_symbolMarket Data — Crypto Spot PriceInspect
Current spot price for one Crypto symbol from Pyth Network. Symbol format: Crypto pair BASE-QUOTE (e.g. BTC-USD, ETH-USD, SOL-USD). Example: BTC-USD. Substitute the path tail with any valid symbol from /list.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | Asset symbol in the format verified for this operation. List coverage may exceed free price coverage; not every listed symbol can be queried. | |
| session | No | The web documentation and OpenAPI enums conflict. Free non-stock examples omit this parameter rather than choose an unverified enum. |
blockrun_get_api_v1_fx_listMarket Data — List FX SymbolsInspect
List available FX symbols from Pyth feeds. Free discovery endpoint. Supports q (search) and limit (max 2000) query params.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Optional substring filter on symbol or display name. | |
| limit | No |
blockrun_get_api_v1_fx_price_symbolMarket Data — FX Spot PriceInspect
Current spot price for one FX symbol from Pyth Network. Symbol format: Currency pair BASE-QUOTE (e.g. EUR-USD, GBP-USD, JPY-USD). Example: EUR-USD. Substitute the path tail with any valid symbol from /list.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | Asset symbol in the format verified for this operation. List coverage may exceed free price coverage; not every listed symbol can be queried. | |
| session | No | The web documentation and OpenAPI enums conflict. Free non-stock examples omit this parameter rather than choose an unverified enum. |
blockrun_get_api_v1_stocks_market_listMarket Data — List Global Stock SymbolsInspect
List available Global Stock symbols from Pyth feeds. Free discovery endpoint. Supports q (search) and limit (max 2000) query params.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Optional substring filter on symbol or display name. | |
| limit | No | ||
| market | Yes | Stock market code. An available ticker list does not imply that prices or history are available for this market. |
blockrun_get_api_v1_usstock_listMarket Data — List US Stock SymbolsInspect
List available US Stock symbols from Pyth feeds. Free discovery endpoint. Supports q (search) and limit (max 2000) query params.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Optional substring filter on symbol or display name. | |
| limit | No |
blockrun_get_api_v1_zerox_gasless_chainsRead-only DEX — 0x — List chains where the Gasless API is supportedInspect
List chains where the Gasless API is supported. Provider: 0x. Free to call — BlockRun earns the on-chain affiliate fee set on each quote, not an x402 charge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
blockrun_get_api_v1_zerox_gasless_priceRead-only DEX — 0x — Gasless indicative price quoteInspect
Gasless indicative price quote. Provider: 0x. Free to call — BlockRun earns the on-chain affiliate fee set on each quote, not an x402 charge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| taker | No | The address which holds the `sellToken` balance and has the allowance set for the swap | |
| chainId | Yes | Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains | |
| buyToken | Yes | The contract address of the token to buy | |
| recipient | No | The address to receive the `buyToken`. If not provided, defaults to the taker address. Not supported for wrap/unwrap operations. | |
| sellToken | Yes | The contract address of the token to sell. Native token is not supported | |
| sellAmount | Yes | The amount of `sellToken` in `sellToken` base units to sell | |
| slippageBps | No | The maximum acceptable slippage of the `buyToken` in Bps. 0x sets the optimal slippage tolerance per trade by default. To mitigate the risk of MEV attacks, we recommend adjusting this value only when trading low-liquidity tokens. Deprecated: use `slippagePpm` instead. `slippageBps` accepts only whole numbers. | |
| slippagePpm | No | The maximum acceptable slippage of the `buyToken` in parts-per-million (PPM). Mutually exclusive with `slippageBps`. e.g. 3000 PPM = 30 BPS = 0.30%. | |
| excludedSources | No | Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. `See https://api.0x.org/sources?chainId=<chain_id>` with the desired chain's ID for a full list of sources. Separate multiple sources with a comma | |
| tradeSurplusMaxBps | No | The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`. | |
| tradeSurplusMaxPpm | No | The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%. | |
| tradeSurplusRecipient | No | The address to receive any trade surplus. If specified, this address will receive trade surplus when applicable. Otherwise, the taker will receive the surplus. This feature is only available to selected integrators on a custom pricing plan. In other cases, the surplus will be collected by 0x. For assistance with a custom plan, please contact support. |
blockrun_get_api_v1_zerox_gasless_quoteRead-only DEX — 0x — Gasless firm quote — returns trade.eip712 (+ optional approval.eip712) for client to signInspect
Gasless firm quote — returns trade.eip712 (+ optional approval.eip712) for client to sign. Provider: 0x. Free to call — BlockRun earns the on-chain affiliate fee set on each quote, not an x402 charge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| taker | Yes | The address which holds the `sellToken` balance and has the allowance set for the swap | |
| chainId | Yes | Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains | |
| buyToken | Yes | The contract address of the token to buy | |
| recipient | No | The address to receive the `buyToken`. If not provided, defaults to the taker address. Not supported for wrap/unwrap operations. | |
| sellToken | Yes | The contract address of the token to sell. Native token is not supported | |
| sellAmount | Yes | The amount of `sellToken` in `sellToken` base units to sell | |
| slippageBps | No | The maximum acceptable slippage of the `buyToken` in Bps. 0x sets the optimal slippage tolerance per trade by default. To mitigate the risk of MEV attacks, we recommend adjusting this value only when trading low-liquidity tokens. Deprecated: use `slippagePpm` instead. `slippageBps` accepts only whole numbers. | |
| slippagePpm | No | The maximum acceptable slippage of the `buyToken` in parts-per-million (PPM). Mutually exclusive with `slippageBps`. e.g. 3000 PPM = 30 BPS = 0.30%. | |
| excludedSources | No | Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See `https://api.0x.org/sources?chainId=<chain_id>` with the desired chain's ID for a full list of sources. Separate multiple sources with a comma | |
| tradeSurplusMaxBps | No | The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`. | |
| tradeSurplusMaxPpm | No | The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%. | |
| tradeSurplusRecipient | No | The address to receive any trade surplus. If specified, this address will receive trade surplus when applicable. Otherwise, the taker will receive the surplus. This feature is only available to selected integrators on a custom pricing plan. In other cases, the surplus will be collected by 0x. For assistance with a custom plan, please contact support. |
blockrun_get_api_v1_zerox_gasless_status_trade_hashRead-only DEX — 0x — Poll status of a gasless trade by tradeHash. Path = /gasless/status/{tradeHash}Inspect
Poll status of a gasless trade by tradeHash. Path = /gasless/status/{tradeHash}. Provider: 0x. Free to call — BlockRun earns the on-chain affiliate fee set on each quote, not an x402 charge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trade_hash | Yes | Existing trade identifier. A zero-filled discovery placeholder is not evidence of a real trade-status query. |
blockrun_get_api_v1_zerox_priceRead-only DEX — 0x — Indicative Permit2 swap quote (no commitment)Inspect
Indicative Permit2 swap quote (no commitment). Provider: 0x. Free to call — BlockRun earns the on-chain affiliate fee set on each quote, not an x402 charge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| taker | No | The address which holds the `sellToken` balance and has the allowance set for the swap | |
| chainId | Yes | Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains | |
| buyToken | Yes | The contract address of the token to buy | |
| gasPrice | No | The target gas price (in wei) for the swap transaction. If not provided, the default value is based on the 0x gas price oracle | |
| txOrigin | No | The address of the external account that started the transaction. This is only needed if `taker` is a smart contract. | |
| buyAmount | No | The amount of `buyToken` in `buyToken` base units to buy. Exactly one of `sellAmount` or `buyAmount` must be provided — specifying both will result in an error. | |
| recipient | No | The address to receive the `buyToken`. If not provided, defaults to the taker address. Not supported for wrap/unwrap operations. | |
| sellToken | Yes | The contract address of the token to sell | |
| sellAmount | No | The amount of `sellToken` in `sellToken` base units to sell. Exactly one of `sellAmount` or `buyAmount` must be provided — specifying both will result in an error. | |
| slippageBps | No | The maximum acceptable slippage of the `buyToken` in Bps. If this parameter is set to 0, no slippage will be tolerated. If not provided, the default slippage tolerance is 100Bps. Deprecated: use `slippagePpm` instead. `slippageBps` accepts only whole numbers. | |
| slippagePpm | No | The maximum acceptable slippage of the `buyToken` in parts-per-million (PPM). Mutually exclusive with `slippageBps`. e.g. 3000 PPM = 30 BPS = 0.30%. | |
| wrapUnwrapMode | No | Controls how native wrap/unwrap trades are executed. `direct` calls the wrapped-native token contract directly. `settler` routes wrap/unwrap through Settler or Allowance Holder for compatibility. Ignored for non-wrap/unwrap swaps. If omitted, `direct` mode is used. | |
| excludedSources | No | Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See https://api.0x.org/sources?chainId=<chain_id> with the desired chain's ID for a full list of sources. Separate multiple sources with a comma | |
| sellEntireBalance | No | If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://docs.0x.org/docs/0x-swap-api/additional-topics/sell-entire-balance). | |
| tradeSurplusMaxBps | No | The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`. | |
| tradeSurplusMaxPpm | No | The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%. | |
| tradeSurplusRecipient | No | The address to receive any trade surplus. If specified, this address will receive trade surplus when applicable. Otherwise, the taker will receive the surplus. This feature is only available to selected integrators on a custom pricing plan. In other cases, the surplus will be collected by 0x. For assistance with a custom plan, please contact support. |
blockrun_get_api_v1_zerox_quoteRead-only DEX — 0x — Firm Permit2 swap quote with permit2.eip712 + tx dataInspect
Firm Permit2 swap quote with permit2.eip712 + tx data. Provider: 0x. Free to call — BlockRun earns the on-chain affiliate fee set on each quote, not an x402 charge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| taker | Yes | The address which holds the `sellToken` balance and has the allowance set for the swap | |
| chainId | Yes | Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains | |
| buyToken | Yes | The contract address of the token to buy | |
| gasPrice | No | The target gas price (in wei) for the swap transaction. If not provided, the default value is based on the 0x gas price oracle | |
| txOrigin | No | The address of the external account that started the transaction. This is only needed if `taker` is a smart contract. | |
| buyAmount | No | The amount of `buyToken` in `buyToken` base units to buy. Exactly one of `sellAmount` or `buyAmount` must be provided — specifying both will result in an error. | |
| recipient | No | The address to receive the `buyToken`. If not provided, defaults to the taker address. Not supported for wrap/unwrap operations. | |
| sellToken | Yes | The contract address of the token to sell | |
| sellAmount | No | The amount of `sellToken` in `sellToken` base units to sell. Exactly one of `sellAmount` or `buyAmount` must be provided — specifying both will result in an error. | |
| slippageBps | No | The maximum acceptable slippage of the `buyToken` in Bps. If this parameter is set to 0, no slippage will be tolerated. If not provided, the default slippage tolerance is 100Bps. Deprecated: use `slippagePpm` instead. `slippageBps` accepts only whole numbers. | |
| slippagePpm | No | The maximum acceptable slippage of the `buyToken` in parts-per-million (PPM). Mutually exclusive with `slippageBps`. e.g. 3000 PPM = 30 BPS = 0.30%. | |
| wrapUnwrapMode | No | Controls how native wrap/unwrap trades are executed. `direct` calls the wrapped-native token contract directly. `settler` routes wrap/unwrap through Settler or Allowance Holder for compatibility. Ignored for non-wrap/unwrap swaps. If omitted, `direct` mode is used. | |
| excludedSources | No | Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. `See https://api.0x.org/sources?chainId=<chain_id>` with the desired chain's ID for a full list of sources. Separate multiple sources with a comma | |
| sellEntireBalance | No | If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://docs.0x.org/docs/0x-swap-api/additional-topics/sell-entire-balance). | |
| tradeSurplusMaxBps | No | The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`. | |
| tradeSurplusMaxPpm | No | The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%. | |
| tradeSurplusRecipient | No | The address to receive any trade surplus. If specified, this address will receive trade surplus when applicable. Otherwise, the taker will receive the surplus. This feature is only available to selected integrators on a custom pricing plan. In other cases, the surplus will be collected by 0x. For assistance with a custom plan, please contact support. |
blockrun_get_api_v1_zerox_swap_chainsRead-only DEX — 0x — List chains where the Swap API is supportedInspect
List chains where the Swap API is supported. Provider: 0x. Free to call — BlockRun earns the on-chain affiliate fee set on each quote, not an x402 charge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
blockrun_get_v1_defillama_chainsDeFi Data — DefiLlama — chainsInspect
TVL by chain — every chain DefiLlama tracks with current TVL totals. DefiLlama is open Apache 2.0; this is a paid wrapper that adds metering and reliability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
blockrun_get_v1_defillama_prices_coinsDeFi Data — DefiLlama — pricesInspect
Token price lookup. Pass coin identifiers as /v1/defillama/prices/{coins} (e.g. coingecko:bitcoin, ethereum:0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2). Supports comma-separated lists. DefiLlama is open Apache 2.0; this is a paid wrapper that adds metering and reliability.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| coins | Yes | Comma-separated coin identifiers |
blockrun_get_v1_defillama_protocolsDeFi Data — DefiLlama — protocolsInspect
List of every DeFi protocol DefiLlama tracks, with current and historical TVL across chains. DefiLlama is open Apache 2.0; this is a paid wrapper that adds metering and reliability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
blockrun_get_v1_defillama_protocol_slugDeFi Data — DefiLlama — protocolInspect
Detailed TVL + breakdown for a single protocol. Pass slug as /v1/defillama/protocol/{slug} (e.g. aave, uniswap). DefiLlama is open Apache 2.0; this is a paid wrapper that adds metering and reliability.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | DefiLlama protocol slug — `aave`, `uniswap`, `lido`, … |
blockrun_get_v1_defillama_yieldsDeFi Data — DefiLlama — yieldsInspect
Every tracked yield pool across DeFi (lending, LPs, staking, vaults) with current APY/TVL. DefiLlama is open Apache 2.0; this is a paid wrapper that adds metering and reliability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
blockrun_get_v1_pm_binance_candles_symbolPrediction Markets and Derivatives — Get OHLCV candlestick data for a Binance trading pairInspect
Get OHLCV candlestick data for a Binance trading pair Provider: Predexon (binance). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max candles (1-1500, default 500) | |
| symbol | Yes | BTCUSDT`, `ETHUSDT`, `SOLUSDT`, or `XRPUSDT | |
| end_time | No | Unix timestamp (seconds) | |
| interval | No | 1s`, `1m`, `5m`, `15m`, `1h`, `4h`, `1d` (default `1m`) | |
| start_time | No | Unix timestamp (seconds) |
blockrun_get_v1_pm_binance_ticks_symbolPrediction Markets and Derivatives — Get raw book ticker data at microsecond granularityInspect
Get raw book ticker data at microsecond granularity Provider: Predexon (binance). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max ticks per page | |
| symbol | Yes | Asset symbol in the format verified for this operation. List coverage may exceed free price coverage; not every listed symbol can be queried. | |
| end_time | Yes | Unix timestamp (seconds) for range end | |
| start_time | Yes | Unix timestamp (seconds) for range start | |
| pagination_key | No | Cursor for next page |
blockrun_get_v1_pm_kalshi_marketsPrediction Markets and Derivatives — Query Kalshi markets with filtering, sorting, and paginationInspect
Query Kalshi markets with filtering, sorting, and pagination Provider: Predexon (kalshi). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for results. | |
| limit | No | Max results to return (default 20, max 100). | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| ticker | No | Kalshi market ticker(s). | |
| max_price | No | Maximum last price (0-100) | |
| min_price | No | Minimum last price (0-100) | |
| min_volume | No | Minimum dollar volume | |
| predexon_id | No | Filter by predexon ID(s) | |
| event_ticker | No | Filter by event ticker(s) | |
| series_ticker | No | Filter by series ticker(s) | |
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. | |
| min_open_interest | No | Minimum dollar open interest |
blockrun_get_v1_pm_kalshi_orderbooksPrediction Markets and Derivatives — Fetch historical orderbook snapshots for a Kalshi marketInspect
Fetch historical orderbook snapshots for a Kalshi market Provider: Predexon (kalshi). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of snapshots to return | |
| ticker | Yes | The Kalshi market ticker | |
| end_time | Yes | End time in Unix timestamp (milliseconds) | |
| start_time | Yes | Start time in Unix timestamp (milliseconds) | |
| pagination_key | No | Pagination key to get the next chunk of data |
blockrun_get_v1_pm_kalshi_tradesPrediction Markets and Derivatives — Fetch historical Kalshi trade dataInspect
Fetch historical Kalshi trade data Provider: Predexon (kalshi). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of trades to return | |
| order | No | Sort order: asc or desc | |
| ticker | No | Filter by market ticker | |
| end_time | No | Unix timestamp (seconds) for end | |
| min_count | No | Minimum contract count | |
| start_time | No | Unix timestamp (seconds) for start | |
| taker_side | No | Filter by taker side: yes or no | |
| event_ticker | No | Filter by event ticker (prefix match) | |
| pagination_key | No | Cursor for pagination |
blockrun_get_v1_pm_limitless_marketsPrediction Markets and Derivatives — List Limitless markets with filtering and sortingInspect
List Limitless markets with filtering and sorting Provider: Predexon (limitless). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for results. | |
| tags | No | Filter by tag(s) | |
| limit | No | Max results to return (default 20, max 100). | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| token_id | No | Filter by token ID(s) | |
| categories | No | Filter by category(s) | |
| min_volume | No | Minimum volume (USD) | |
| trade_type | No | Filter by trade type: amm or clob | |
| market_slug | No | Filter by market slug(s) | |
| predexon_id | No | Filter by predexon ID(s) | |
| condition_id | No | Filter by condition ID(s) | |
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. | |
| min_open_interest | No | Minimum open interest (USD) |
blockrun_get_v1_pm_limitless_orderbooksPrediction Markets and Derivatives — Fetch historical orderbook snapshots for a Limitless marketInspect
Fetch historical orderbook snapshots for a Limitless market Provider: Predexon (limitless). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of snapshots to return | |
| end_time | Yes | End time in Unix timestamp (milliseconds) | |
| start_time | Yes | Start time in Unix timestamp (milliseconds) | |
| market_slug | Yes | The Limitless market slug | |
| pagination_key | No | Pagination key to get the next chunk of data |
blockrun_get_v1_pm_markets_searchPrediction Markets and Derivatives — Search markets across Polymarket, Kalshi, Limitless, Opinion, and Predict.Fun in a…Inspect
Search markets across Polymarket, Kalshi, Limitless, Opinion, and Predict.Fun in a single call. Not charged when no market matches Provider: Predexon (matching). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Search term (required). NB: this endpoint uses `q`; every other list endpoint uses `search`. | |
| limit | No | Max results to return (default 20, max 100). | |
| venue | No | Filter by venue (polymarket, kalshi, …). | |
| status | No | Filter by market status (e.g. "open", "closed"). |
blockrun_get_v1_pm_opinion_marketsPrediction Markets and Derivatives — List Opinion markets with filtering and sortingInspect
List Opinion markets with filtering and sorting Provider: Predexon (opinion). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for results. | |
| limit | No | Max results to return (default 20, max 100). | |
| labels | No | Filter by label(s) | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| event_id | No | Filter by event/parent market ID(s) | |
| token_id | No | Filter by token ID(s) | |
| market_id | No | Filter by market ID(s) | |
| event_slug | No | Filter by event slug(s) | |
| min_volume | No | Minimum total volume (USD) | |
| market_slug | No | Filter by market slug(s) | |
| market_type | No | Filter by market type: binary or categorical | |
| predexon_id | No | Filter by predexon ID(s) | |
| condition_id | No | Filter by condition ID(s) | |
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. |
blockrun_get_v1_pm_opinion_orderbooksPrediction Markets and Derivatives — Fetch historical orderbook snapshots for an Opinion marketInspect
Fetch historical orderbook snapshots for an Opinion market Provider: Predexon (opinion). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of snapshots to return | |
| end_time | Yes | End time in Unix timestamp (milliseconds) | |
| market_id | Yes | The Opinion market ID | |
| start_time | Yes | Start time in Unix timestamp (milliseconds) | |
| pagination_key | No | Pagination key to get the next chunk of data |
blockrun_get_v1_pm_polymarket_activityPrediction Markets and Derivatives — Fetch trading activity (merges, splits, redeems) for a userInspect
Fetch trading activity (merges, splits, redeems) for a user Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of activities to return (1-500) | |
| order | No | Sort order: asc or desc | |
| wallet | Yes | Wallet address | |
| sort_by | No | Sort by: timestamp or type | |
| end_time | No | Unix timestamp (seconds) for end | |
| start_time | No | Unix timestamp (seconds) for start | |
| market_slug | No | Filter by market slug | |
| condition_id | No | Filter by condition ID | |
| pagination_key | No | Pagination key for cursor-based pagination |
blockrun_get_v1_pm_polymarket_candlesticks_condition_idPrediction Markets and Derivatives — Get historical OHLCV candlestick data for a marketInspect
Get historical OHLCV candlestick data for a market Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_time | No | Unix timestamp (seconds) for end of time range | |
| interval | No | Interval: 0=auto, 1=1m, 5=5m, 15=15m, 60=1h, 1440=1d | |
| start_time | No | Unix timestamp (seconds) for start of time range | |
| condition_id | Yes | Prediction-market condition identifier; not interchangeable with a token_id, event ID or ticker. |
blockrun_get_v1_pm_polymarket_candlesticks_token_token_idPrediction Markets and Derivatives — Get historical OHLCV candlestick data for a single outcome tokenInspect
Get historical OHLCV candlestick data for a single outcome token Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_time | No | Unix timestamp (seconds) for end of time range | |
| interval | No | Interval: 0=auto, 1=1m, 5=5m, 15=15m, 60=1h, 1440=1d | |
| token_id | Yes | Identifier of a prediction-market outcome token, not an ERC-20 contract address. | |
| start_time | No | Unix timestamp (seconds) for start of time range |
blockrun_get_v1_pm_polymarket_cohorts_statsPrediction Markets and Derivatives — Compare performance across trading style cohortsInspect
Compare performance across trading style cohorts Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| window | No | Time window for metrics | |
| min_trades | No | Minimum trades to be included in cohort (filters noise) |
blockrun_get_v1_pm_polymarket_crypto_updownPrediction Markets and Derivatives — List crypto up/down prediction marketsInspect
List crypto up/down prediction markets Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for results. | |
| asset | No | Underlying asset (e.g. BTC, ETH). | |
| limit | No | Max results to return (default 20, max 100). | |
| offset | No | Offset for pagination | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| end_after | No | Only markets with end_time after this Unix timestamp | |
| timeframe | No | Filter by timeframe: 5m, 15m, 1h, 4h, daily | |
| end_before | No | Only markets with end_time before or at this Unix timestamp |
blockrun_get_v1_pm_polymarket_eventsPrediction Markets and Derivatives — List Polymarket events with filtering and sortingInspect
List Polymarket events with filtering and sorting Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Event ID(s). | |
| tag | No | ||
| slug | No | Event slug(s). On /events the slug filter IS `slug` (unlike /markets, which uses `event_slug`). | |
| sort | No | Sort order for results. | |
| limit | No | Max results to return (default 20, max 100). | |
| offset | No | Deprecated — use pagination_key. | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| category | No | ||
| min_volume | No | ||
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. | |
| include_markets | No | Embed child markets in each event. | |
| markets_per_event | No | ||
| min_open_interest | No |
blockrun_get_v1_pm_polymarket_events_keysetPrediction Markets and Derivatives — List Polymarket events with cursor-based keyset paginationInspect
List Polymarket events with cursor-based keyset pagination Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Event ID(s). | |
| tag | No | Filter by tag slug(s) | |
| slug | No | Event slug(s). On /events the slug filter IS `slug` (unlike /markets, which uses `event_slug`). | |
| sort | No | Sort order for results. | |
| limit | No | Max results to return (default 20, max 100). | |
| offset | No | Deprecated — use pagination_key. | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| category | No | Filter by category (e.g. Sports, Crypto) | |
| min_volume | No | Only events with 7d volume >= this (USD) | |
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. | |
| include_markets | No | Embed child markets in each event. | |
| markets_per_event | No | Max markets nested per event when include_markets=true | |
| min_open_interest | No | Only events with current open interest >= this (USD) |
blockrun_get_v1_pm_polymarket_leaderboardPrediction Markets and Derivatives — Get the global leaderboard of smart walletsInspect
Get the global leaderboard of smart wallets Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Results per page | |
| order | No | Sort order | |
| style | No | Comma-separated styles to include (OR logic) | |
| window | No | Time window for metrics | |
| max_roi | No | Maximum ROI (decimal) | |
| min_roi | No | Minimum ROI (decimal) | |
| sort_by | No | Sort field | |
| max_trades | No | Maximum trade count | |
| max_volume | No | Maximum volume in USD | |
| min_trades | No | Minimum trade count | |
| min_volume | No | Minimum volume in USD | |
| max_win_rate | No | Maximum win rate (decimal) | |
| min_win_rate | No | Minimum win rate (decimal) | |
| exclude_style | No | Comma-separated styles to exclude | |
| max_total_pnl | No | Maximum total PnL in USD (realized + unrealized - net fees) | |
| min_total_pnl | No | Minimum total PnL in USD (realized + unrealized - net fees) | |
| max_entry_edge | No | Maximum entry edge (avg_sell - avg_buy) | |
| min_entry_edge | No | Minimum entry edge (avg_sell - avg_buy) | |
| pagination_key | No | Cursor for pagination | |
| max_realized_pnl | No | Maximum realized PnL in USD | |
| min_realized_pnl | No | Minimum realized PnL in USD | |
| max_avg_buy_price | No | Maximum avg buy price (0-1) | |
| max_avg_trade_usd | No | Maximum avg trade size in USD | |
| max_profit_factor | No | Maximum profit factor | |
| min_avg_buy_price | No | Minimum avg buy price (0-1) | |
| min_avg_trade_usd | No | Minimum avg trade size in USD | |
| min_profit_factor | No | Minimum profit factor | |
| max_avg_sell_price | No | Maximum avg sell price (0-1) | |
| min_avg_sell_price | No | Minimum avg sell price (0-1) | |
| max_wallet_age_days | No | Maximum wallet age in days | |
| min_wallet_age_days | No | Minimum wallet age in days |
blockrun_get_v1_pm_polymarket_leaderboard_market_condition_idPrediction Markets and Derivatives — Get leaderboard for a specific marketInspect
Get leaderboard for a specific market Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Results per page | |
| order | No | Sort order | |
| window | No | Time window | |
| sort_by | No | Sort field | |
| max_trades | No | Maximum trades in this market | |
| max_volume | No | Maximum volume in this market | |
| min_trades | No | Minimum trades in this market | |
| min_volume | No | Minimum volume in this market | |
| condition_id | Yes | Prediction-market condition identifier; not interchangeable with a token_id, event ID or ticker. | |
| max_total_pnl | No | Maximum total PnL in this market (USD, net of fees) | |
| min_total_pnl | No | Minimum total PnL in this market (USD, net of fees) | |
| max_entry_edge | No | Maximum entry edge (avg_sell - avg_buy) | |
| min_entry_edge | No | Minimum entry edge (avg_sell - avg_buy) | |
| pagination_key | No | Cursor for pagination | |
| max_avg_buy_price | No | Maximum avg buy price (0-1) | |
| min_avg_buy_price | No | Minimum avg buy price (0-1) | |
| max_avg_sell_price | No | Maximum avg sell price (0-1) | |
| min_avg_sell_price | No | Minimum avg sell price (0-1) |
blockrun_get_v1_pm_polymarket_market_condition_id_smart_moneyPrediction Markets and Derivatives — View smart money positioning on a specific marketInspect
View smart money positioning on a specific market Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| window | No | Time window for metrics | |
| min_roi | No | Minimum global ROI to be 'smart' (decimal) | |
| min_trades | No | Minimum global trade count | |
| min_volume | No | Minimum global volume (USD) | |
| condition_id | Yes | Prediction-market condition identifier; not interchangeable with a token_id, event ID or ticker. | |
| min_win_rate | No | Minimum global win rate (decimal) | |
| min_total_pnl | No | Minimum global total PnL to be 'smart' (USD, net of fees) | |
| min_realized_pnl | No | Minimum global realized PnL to be 'smart' (USD) | |
| min_profit_factor | No | Minimum global profit factor |
blockrun_get_v1_pm_polymarket_market_condition_id_top_holdersPrediction Markets and Derivatives — Get top holders for a specific market ranked by position sizeInspect
Get top holders for a specific market ranked by position size Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| side | No | Filter by position side: 'yes' or 'no' | |
| limit | No | Results per page | |
| min_shares | No | Minimum shares held (normalized) | |
| min_trades | No | Minimum number of trades | |
| condition_id | Yes | Prediction-market condition identifier; not interchangeable with a token_id, event ID or ticker. | |
| include_count | No | Include total holder count (slower query) | |
| pagination_key | No | Cursor for pagination |
blockrun_get_v1_pm_polymarket_market_price_token_idPrediction Markets and Derivatives — Get current or historical price for a specific tokenInspect
Get current or historical price for a specific token Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| at_time | No | Unix timestamp (seconds) for historical price | |
| token_id | Yes | Identifier of a prediction-market outcome token, not an ERC-20 contract address. |
blockrun_get_v1_pm_polymarket_marketsPrediction Markets and Derivatives — Query Polymarket markets with filtering, sorting, and paginationInspect
Query Polymarket markets with filtering, sorting, and pagination Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for results. | |
| tags | No | Filter by Polymarket tag(s). | |
| limit | No | Max results to return (default 20, max 100). | |
| offset | No | Deprecated — use pagination_key. | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| token_id | No | ||
| end_after | No | Only markets ending after this unix timestamp (seconds). | |
| market_id | No | ||
| max_price | No | ||
| min_price | No | ||
| end_before | No | Only markets ending before this unix timestamp (seconds). | |
| event_slug | No | Event slug(s). The slug filter for /markets is `event_slug` (or `market_slug`), NOT `slug`. | |
| min_volume | No | ||
| market_slug | No | Market slug(s). | |
| predexon_id | No | Canonical cross-venue Predexon ID(s). | |
| question_id | No | ||
| condition_id | No | Polymarket condition ID(s). | |
| min_trades_1d | No | ||
| min_trades_7d | No | ||
| min_volume_1d | No | ||
| min_volume_7d | No | ||
| min_trades_30d | No | ||
| min_volume_30d | No | ||
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. | |
| min_open_interest | No |
blockrun_get_v1_pm_polymarket_markets_condition_id_open_interestPrediction Markets and Derivatives — Get historical open interest data for a marketInspect
Get historical open interest data for a market Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_time | No | Unix timestamp (seconds) for end | |
| start_time | No | Unix timestamp (seconds) for start | |
| granularity | No | Time granularity | |
| condition_id | Yes | Prediction-market condition identifier; not interchangeable with a token_id, event ID or ticker. |
blockrun_get_v1_pm_polymarket_markets_keysetPrediction Markets and Derivatives — List Polymarket markets with cursor-based keyset pagination (same filters as /poly…Inspect
List Polymarket markets with cursor-based keyset pagination (same filters as /polymarket/markets) Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for results. | |
| tags | No | Filter by Polymarket tag(s). | |
| limit | No | Max results to return (default 20, max 100). | |
| offset | No | Deprecated — use pagination_key. | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| token_id | No | Filter by token ID(s) - matches either side_a or side_b | |
| end_after | No | Only markets ending after this unix timestamp (seconds). | |
| market_id | No | Filter by market ID(s) | |
| max_price | No | Maximum price | |
| min_price | No | Minimum price | |
| end_before | No | Only markets ending before this unix timestamp (seconds). | |
| event_slug | No | Event slug(s). The slug filter for /markets is `event_slug` (or `market_slug`), NOT `slug`. | |
| min_volume | No | Minimum volume (USD) | |
| market_slug | No | Market slug(s). | |
| predexon_id | No | Canonical cross-venue Predexon ID(s). | |
| question_id | No | Filter by question ID(s) | |
| condition_id | No | Polymarket condition ID(s). | |
| min_trades_1d | No | Minimum rolling 1-day trade count | |
| min_trades_7d | No | Minimum rolling 7-day trade count | |
| min_volume_1d | No | Minimum rolling 1-day volume (USD) | |
| min_volume_7d | No | Minimum rolling 7-day volume (USD) | |
| min_trades_30d | No | Minimum rolling 30-day trade count | |
| min_volume_30d | No | Minimum rolling 30-day volume (USD) | |
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. | |
| min_open_interest | No | Minimum open interest (USD) |
blockrun_get_v1_pm_polymarket_markets_smart_activityPrediction Markets and Derivatives — Discover markets where high-performing wallets are activeInspect
Discover markets where high-performing wallets are active Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Results per page | |
| order | No | Sort order | |
| status | No | Filter by market status: open or closed | |
| window | No | Time window for metrics | |
| min_roi | No | Minimum global ROI to be 'smart' (decimal) | |
| sort_by | No | Sort markets by this metric | |
| min_trades | No | Minimum global trade count | |
| min_volume | No | Minimum global volume (USD) | |
| min_win_rate | No | Minimum global win rate (decimal) | |
| min_total_pnl | No | Minimum global total PnL to be 'smart' (USD, net of fees) | |
| pagination_key | No | Cursor for pagination | |
| min_realized_pnl | No | Minimum global realized PnL to be 'smart' (USD) | |
| min_profit_factor | No | Minimum global profit factor |
blockrun_get_v1_pm_polymarket_markets_token_id_volumePrediction Markets and Derivatives — Get historical cumulative volume data for a marketInspect
Get historical cumulative volume data for a market Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_time | No | Unix timestamp (seconds) for end | |
| token_id | Yes | Identifier of a prediction-market outcome token, not an ERC-20 contract address. | |
| start_time | No | Unix timestamp (seconds) for start | |
| granularity | No | Time granularity |
blockrun_get_v1_pm_polymarket_orderbooksPrediction Markets and Derivatives — Get historical orderbook snapshots for a tokenInspect
Get historical orderbook snapshots for a token Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of snapshots to return | |
| end_time | Yes | End time in Unix timestamp (milliseconds) | |
| token_id | Yes | The token ID (asset) for the Polymarket market | |
| start_time | Yes | Start time in Unix timestamp (milliseconds) | |
| pagination_key | No | Pagination key to get the next chunk of data |
blockrun_get_v1_pm_polymarket_positionsPrediction Markets and Derivatives — Fetch all user positions with filtering and paginationInspect
Fetch all user positions with filtering and pagination Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum positions per page (1-500) | |
| order | No | Sort order (desc for latest first, asc for streaming from oldest) | |
| wallet | No | Filter by wallet address | |
| order_by | No | Order by block number or timestamp | |
| token_id | No | Filter by token ID | |
| max_block | No | Maximum block number (inclusive) | |
| min_block | No | Minimum block number (inclusive) | |
| condition_id | No | Filter by market condition ID | |
| max_timestamp | No | Maximum timestamp in Unix seconds (inclusive) | |
| min_timestamp | No | Minimum timestamp in Unix seconds (inclusive) | |
| pagination_key | No | Cursor for pagination |
blockrun_get_v1_pm_polymarket_tradesPrediction Markets and Derivatives — Query historical Polymarket trade data with flexible filteringInspect
Query historical Polymarket trade data with flexible filtering Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of trades to return | |
| order | No | Sort order: asc or desc | |
| wallet | No | Filter by wallet address(es) — single address or comma-separated list (max 50) | |
| builder | No | Filter by V2 builder attribution tag (bytes32 hex, 0x + 64 hex chars) | |
| tx_hash | No | Filter by transaction hash (bytes32 hex, 0x + 64 hex chars) | |
| end_time | No | Unix timestamp (seconds) for end | |
| token_id | No | Filter by token ID | |
| min_total | No | Minimum trade amount in USD | |
| order_hash | No | Filter by order hash (bytes32 hex, 0x + 64 hex chars) | |
| start_time | No | Unix timestamp (seconds) for start | |
| market_slug | No | Filter by market slug | |
| condition_id | No | Filter by condition ID | |
| pagination_key | No | Cursor for pagination |
blockrun_get_v1_pm_polymarket_uma_market_condition_idPrediction Markets and Derivatives — Get current UMA oracle status and event timeline for a single marketInspect
Get current UMA oracle status and event timeline for a single market Provider: Predexon (uma). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| condition_id | Yes | Prediction-market condition identifier; not interchangeable with a token_id, event ID or ticker. | |
| events_limit | No | Max events to return (0 to skip) | |
| events_pagination_key | No | Cursor for next event page |
blockrun_get_v1_pm_polymarket_uma_marketsPrediction Markets and Derivatives — List UMA oracle questions filtered by state (proposed, disputed, resolved, …)Inspect
List UMA oracle questions filtered by state (proposed, disputed, resolved, …) Provider: Predexon (uma). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max results to return (default 20, max 100). | |
| state | No | Oracle state: proposed, disputed, resolved, … | |
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. |
blockrun_get_v1_pm_polymarket_volume_chart_condition_idPrediction Markets and Derivatives — Get volume chart with YES/NO breakdown for a marketInspect
Get volume chart with YES/NO breakdown for a market Provider: Predexon (polymarket). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_time | Yes | Unix timestamp (seconds) for end of time range | |
| start_time | Yes | Unix timestamp (seconds) for start of time range | |
| granularity | No | Time granularity: hour, day, or week | |
| condition_id | Yes | Prediction-market condition identifier; not interchangeable with a token_id, event ID or ticker. |
blockrun_get_v1_pm_polymarket_wallet_identity_walletPrediction Markets and Derivatives — Fetch identity and profile metadata for a wallet addressInspect
Fetch identity and profile metadata for a wallet address Provider: Predexon (wallet). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| wallet | Yes | Wallet address whose public data is queried. |
blockrun_get_v1_pm_polymarket_wallet_markets_walletPrediction Markets and Derivatives — Get per-market performance breakdown for a walletInspect
Get per-market performance breakdown for a wallet Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Results per page | |
| order | No | Sort order | |
| wallet | Yes | Wallet address whose public data is queried. | |
| window | No | Time window | |
| sort_by | No | Sort field | |
| min_trades | No | Minimum trades per market | |
| pagination_key | No | Cursor for pagination |
blockrun_get_v1_pm_polymarket_wallet_pnl_walletPrediction Markets and Derivatives — Get P&L summary and realized P&L time series for a walletInspect
Get P&L summary and realized P&L time series for a wallet Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| wallet | Yes | Wallet address whose public data is queried. | |
| end_time | No | Unix timestamp (seconds) for end of range | |
| start_time | No | Unix timestamp (seconds) for start of range | |
| granularity | Yes | Time granularity for PnL data | |
| condition_id | No | Filter to a specific market by condition ID |
blockrun_get_v1_pm_polymarket_wallet_positions_walletPrediction Markets and Derivatives — Get open and historical positions for a wallet addressInspect
Get open and historical positions for a wallet address Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of positions to return (1-200) | |
| order | No | Sort order: asc or desc | |
| wallet | Yes | Wallet address whose public data is queried. | |
| sort_by | No | Field to sort by | |
| min_shares | No | Minimum number of shares to include | |
| market_slug | No | Filter by market slug | |
| condition_id | No | Filter to a specific market by condition ID | |
| include_closed | No | Include zero-balance (closed) positions | |
| pagination_key | No | Cursor for pagination |
blockrun_get_v1_pm_polymarket_wallets_filterPrediction Markets and Derivatives — Filter wallets by market trades with AND/OR logicInspect
Filter wallets by market trades with AND/OR logic Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Results per page | |
| order | No | Sort order | |
| window | No | Time window for metrics | |
| markets | Yes | Comma-separated market condition IDs (1-10 markets) | |
| min_roi | No | Minimum combined ROI across specified markets (decimal) | |
| sort_by | No | Sort field (based on combined metrics) | |
| min_trades | No | Minimum combined trade count across specified markets | |
| min_volume | No | Minimum combined volume across specified markets (USD) | |
| market_logic | No | AND = traded ALL markets, OR = traded ANY market | |
| min_win_rate | No | Minimum combined win rate (decimal) | |
| max_total_pnl | No | Maximum combined total PnL across specified markets (USD, net of fees) | |
| min_total_pnl | No | Minimum combined total PnL across specified markets (USD, net of fees) | |
| max_entry_edge | No | Maximum combined entry edge | |
| min_entry_edge | No | Minimum combined entry edge | |
| pagination_key | No | Cursor for pagination | |
| max_realized_pnl | No | Maximum combined realized PnL across specified markets (USD) | |
| min_realized_pnl | No | Minimum combined realized PnL across specified markets (USD) | |
| max_avg_buy_price | No | Maximum combined avg buy price (0-1) | |
| min_avg_buy_price | No | Minimum combined avg buy price (0-1) | |
| min_profit_factor | No | Minimum combined profit factor | |
| max_avg_sell_price | No | Maximum combined avg sell price (0-1) | |
| min_avg_sell_price | No | Minimum combined avg sell price (0-1) |
blockrun_get_v1_pm_polymarket_wallet_similar_walletPrediction Markets and Derivatives — Find wallets with similar market portfoliosInspect
Find wallets with similar market portfolios Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Results per page | |
| wallet | Yes | Wallet address whose public data is queried. | |
| window | No | Time window for metrics | |
| pagination_key | No | Cursor for pagination | |
| min_overlap_pct | No | Minimum overlap percentage (0-1). E.g., 0.5 = at least 50% market overlap | |
| min_overlap_markets | No | Minimum number of overlapping markets |
blockrun_get_v1_pm_polymarket_wallets_profilesPrediction Markets and Derivatives — Batch retrieve wallet profiles for multiple addressesInspect
Batch retrieve wallet profiles for multiple addresses Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addresses | Yes | Comma-separated wallet addresses (max 20) |
blockrun_get_v1_pm_polymarket_wallet_volume_chart_walletPrediction Markets and Derivatives — Get volume chart broken down by BUY/SELL side for a walletInspect
Get volume chart broken down by BUY/SELL side for a wallet Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| wallet | Yes | Wallet address whose public data is queried. | |
| end_time | Yes | Unix timestamp (seconds) for end of time range | |
| start_time | Yes | Unix timestamp (seconds) for start of time range | |
| granularity | No | Time granularity: hour, day, or week |
blockrun_get_v1_pm_polymarket_wallet_walletPrediction Markets and Derivatives — Get a complete smart wallet profile with all metricsInspect
Get a complete smart wallet profile with all metrics Provider: Predexon (polymarket). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. The path segment shown is a placeholder — substitute a real id from the matching list endpoint (e.g. /api/v1/pm/polymarket/markets). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| wallet | Yes | Wallet address whose public data is queried. |
blockrun_get_v1_pm_predictfun_marketsPrediction Markets and Derivatives — List Predict.Fun markets with filtering and sortingInspect
List Predict.Fun markets with filtering and sorting Provider: Predexon (predictfun). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for results. | |
| limit | No | Max results to return (default 20, max 100). | |
| search | No | Free-text search over market/question text (min 3 chars). Note: this param is `search` here, NOT `q` — only /markets/search uses `q`. | |
| status | No | Filter by market status (e.g. "open", "closed"). | |
| token_id | No | Filter by token ID(s) | |
| market_id | No | Filter by market ID(s) | |
| event_slug | No | Filter by event slug(s) — returns all outcomes under that event | |
| market_slug | No | Filter by market slug(s) | |
| predexon_id | No | Filter by predexon ID(s) | |
| condition_id | No | Filter by condition ID(s) | |
| min_bid_depth | No | Minimum bid depth | |
| market_variant | No | Filter by market variant: DEFAULT, CRYPTO_UP_DOWN, SPORTS_TEAM_MATCH, SPORTS_MATCH, TWEET_COUNT | |
| pagination_key | No | Opaque cursor from a prior response for keyset pagination. |
blockrun_get_v1_pm_predictfun_orderbooksPrediction Markets and Derivatives — Fetch historical orderbook snapshots for a Predict.Fun marketInspect
Fetch historical orderbook snapshots for a Predict.Fun market Provider: Predexon (predictfun). Tier 1 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of snapshots to return | |
| end_time | Yes | End time in Unix timestamp (milliseconds) | |
| market_id | Yes | The PredictFun market ID | |
| start_time | Yes | Start time in Unix timestamp (milliseconds) | |
| pagination_key | No | Pagination key to get the next chunk of data |
blockrun_post_v1_exa_find_similarWeb Search and Content — Exa Find SimilarInspect
Find pages semantically similar to a given URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Source URL to find pages similar to. | |
| numResults | No | ||
| excludeSourceDomain | No |
blockrun_post_v1_exa_searchWeb Search and Content — Exa Web SearchInspect
Neural and keyword web search powered by Exa. Optional category filter: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | ||
| query | Yes | Search query. | |
| category | No | Optional category filter (company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report). | |
| numResults | No | ||
| excludeDomains | No | ||
| includeDomains | No | ||
| endPublishedDate | No | ISO-8601 date. | |
| startPublishedDate | No | ISO-8601 date. |
blockrun_post_v1_phone_lookupPhone Data — Phone Number Carrier LookupInspect
Look up carrier and line type (landline / mobile / VoIP) for any phone number via Twilio Lookup. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| phoneNumber | Yes | Phone number to look up (E.164). |
blockrun_post_v1_phone_lookup_fraudPhone Data — Phone Number Fraud LookupInspect
Carrier + fraud signals (SIM swap, call forwarding) via Twilio Lookup. Useful for KYC and account-takeover defenses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| phoneNumber | Yes | Phone number to look up (E.164). |
blockrun_post_v1_pm_polymarket_wallet_identitiesPrediction Markets and Derivatives — Bulk identity lookup for up to 200 wallet addresses (POST body: {addresses: [..]})Inspect
Bulk identity lookup for up to 200 wallet addresses (POST body: {addresses: [..]}) Provider: Predexon (wallet). Tier 2 pricing — payment goes directly to the Predexon recipient wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addresses | Yes | Wallet addresses to look up (max 200) |
blockrun_post_v1_rpc_networkRead-only Blockchain RPC — Multi-chain RPCInspect
Read-only Blockchain RPC — Multi-chain RPC Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| network | Yes | Blockchain network slug, for example ethereum, base or solana. Use only read-only JSON-RPC methods. |
blockrun_post_v1_searchWeb Search and Content — Live web / news / X searchInspect
Live web / news / X search. Billed flat per call from the account balance. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query text (1-1000 characters) | |
| sources | No | Sources to search (default: `["web"]`) | |
| to_date | No | End date filter (`YYYY-MM-DD`) | |
| from_date | No | Start date filter (`YYYY-MM-DD`) | |
| max_results | No | Maximum results per source, 1-50 (default: 10) |
blockrun_post_v1_solana_rpcRead-only Blockchain RPC — Solana JSON-RPCInspect
Same JSON-RPC body; separate Solana-only endpoint. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Same JSON-RPC body; separate Solana-only endpoint. |
blockscout_get_chain_id_api_v2_addressesBlockscout — List addresses holding native coins sorted by balance - top accountsInspect
Retrieves a paginated list of addresses holding the native coin, sorted by balance. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| hash | No | Address hash for paging | |
| sort | No | Sort results by: * balance - Sort by account balance * transactions_count - Sort by number of transactions Should be used together with `order` parameter. | |
| order | No | Sort order: * asc - Ascending order * desc - Descending order Should be used together with `sort` parameter. | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| transactions_count | No | Transactions count for paging Import profile accepts the integer branch only; other union branches are not exposed. | |
| fetched_coin_balance | No | Fetched coin balance for paging |
blockscout_get_chain_id_api_v2_addresses_address_hash_paramBlockscout — Retrieve detailed information about a specific address or contractInspect
Retrieves detailed information for a specific address, including balance, transaction count, and metadata. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_beacBlockscout — List Beacon Deposits for a specific addressInspect
Retrieves Beacon deposits for a specific address. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Deposit index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_blocBlockscout — List blocks validated (mined) by a specific validator/miner addressInspect
Retrieves blocks that were validated (mined) by a specific address. Useful for tracking validator/miner performance. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_celoBlockscout — List Celo election rewards for a specific addressInspect
Retrieves Celo election rewards for a specific address. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Type for paging | |
| amount | No | Amount for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| epoch_number | No | Epoch number for paging | |
| address_hash_param | Yes | Address hash in the path | |
| associated_account_address_hash | No | Associated account address hash for paging |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_co_2Blockscout — Get daily native coin balance snapshots for an address from previous 10 daysInspect
Retrieves daily snapshots of native coin balance for a specific address. Useful for generating balance-over-time charts. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_coinBlockscout — Get native coin balance history for an address showing all balance changesInspect
Retrieves historical native coin balance changes for a specific address, tracking how an address's balance has changed over time. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_counBlockscout — Get activity count stats for a specific addressInspect
Retrieves count statistics for an address, including transactions, token transfers, gas usage, and validations. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_inteBlockscout — List all internal transactions involving a specific addressInspect
Blockscout — List all internal transactions involving a specific address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| filter | No | Filter transactions by direction: * to - Only show transactions sent to this address * from - Only show transactions sent from this address If omitted, all transactions involving the address are returned. | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| transaction_index | No | Transaction index for paging | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_logsBlockscout — List event logs emitted by or involving a specific addressInspect
Retrieves event logs emitted by or involving a specific address. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| topic | No | Log topic param in the query | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_nf_2Blockscout — List NFTs owned by a specific address with optional type filteringInspect
Retrieves a list of NFTs (non-fungible tokens) owned by a specific address, with optional filtering by token type. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Filter by token type. Comma-separated list of: * ERC-721 - Non-fungible tokens * ERC-1155 - Multi-token standard * ERC-404 - Hybrid fungible/non-fungible tokens Example: `ERC-721,ERC-1155` to show both NFT and multi-token transfers Import profile accepts the string branch only; other union branches are not exposed. | |
| chain_id | Yes | The ID of the blockchain | |
| token_id | No | Token ID for paging | |
| token_type | No | Token type for paging | |
| items_count | No | Number of items per page | |
| address_hash_param | Yes | Address hash in the path | |
| token_contract_address_hash | No | Token contract address hash for paging |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_nftBlockscout — List NFTs owned by an address grouped by collection/projectInspect
Retrieves NFTs owned by a specific address, organized by collection. Useful for displaying an address's NFT portfolio grouped by project. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Filter by token type. Comma-separated list of: * ERC-721 - Non-fungible tokens * ERC-1155 - Multi-token standard * ERC-404 - Hybrid fungible/non-fungible tokens Example: `ERC-721,ERC-1155` to show both NFT and multi-token transfers Import profile accepts the string branch only; other union branches are not exposed. | |
| chain_id | Yes | The ID of the blockchain | |
| token_type | No | Token type for paging | |
| items_count | No | Number of items per page | |
| address_hash_param | Yes | Address hash in the path | |
| token_contract_address_hash | No | Token contract address hash for paging |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_tabsBlockscout — Get counters for address tabsInspect
Retrieves counters for various address-related entities (max counter value is 51). Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_to_2Blockscout — List all token balances held by a specific addressInspect
Retrieves all token balances held by a specific address, including ERC-20, ERC-721, ERC-1155, and ERC-404 tokens. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_to_3Blockscout — List token transfers involving a specific address with filtering optionsInspect
Retrieves token transfers involving a specific address, with optional filtering by token type, direction, and specific token. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Filter by token type. Comma-separated list of: * ERC-20 - Fungible tokens * ERC-721 - Non-fungible tokens * ERC-1155 - Multi-token standard * ERC-404 - Hybrid fungible/non-fungible tokens Example: `ERC-20,ERC-721` to show both fungible and NFT transfers Import profile accepts the string branch only; other union branches are not exposed. | |
| index | No | Item index for paging | |
| token | No | Filter token transfers by token contract address. | |
| filter | No | Filter transactions by direction: * to - Only show transactions sent to this address * from - Only show transactions sent from this address If omitted, all transactions involving the address are returned. | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| index_in_batch | No | Index in batch for paging | |
| batch_log_index | No | Batch log index for paging | |
| batch_block_hash | No | Batch block hash for paging | |
| address_hash_param | Yes | Address hash in the path | |
| batch_transaction_hash | No | Batch transaction hash for paging |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_tokeBlockscout — List token balances for an address with pagination and type filteringInspect
Retrieves token balances for a specific address with pagination and filtering by token type. Useful for displaying large token portfolios. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ID for paging | |
| type | No | Filter by token type. Comma-separated list of: * ERC-20 - Fungible tokens * ERC-721 - Non-fungible tokens * ERC-1155 - Multi-token standard * ERC-404 - Hybrid fungible/non-fungible tokens Example: `ERC-20,ERC-721` to show both fungible and NFT transfers Import profile accepts the string branch only; other union branches are not exposed. | |
| value | No | Transaction value for paging Import profile accepts the string branch only; other union branches are not exposed. | |
| chain_id | Yes | The ID of the blockchain | |
| fiat_value | No | Fiat value for paging Import profile accepts the string branch only; other union branches are not exposed. | |
| items_count | No | Number of items per page | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_tranBlockscout — List transactions involving a specific address with to-from filteringInspect
Retrieves transactions involving a specific address, with optional filtering for transactions sent from or to the address. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| fee | No | Transaction fee for paging | |
| hash | No | Transaction hash for paging | |
| sort | No | Sort results by: * block_number - Sort by block number * value - Sort by transaction value * fee - Sort by transaction fee Should be used together with `order` parameter. | |
| index | No | Transaction index for paging Import profile accepts the integer branch only; other union branches are not exposed. | |
| order | No | Sort order: * asc - Ascending order * desc - Descending order Should be used together with `sort` parameter. | |
| value | No | Transaction value for paging Import profile accepts the string branch only; other union branches are not exposed. | |
| filter | No | Filter transactions by direction: * to - Only show transactions sent to this address * from - Only show transactions sent from this address If omitted, all transactions involving the address are returned. | |
| chain_id | Yes | The ID of the blockchain | |
| inserted_at | No | Inserted at timestamp for paging (ISO8601) | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging Import profile accepts the integer branch only; other union branches are not exposed. | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_addresses_address_hash_param_withBlockscout — List validator withdrawals involving a specific addressInspect
Retrieves withdrawals involving a specific address, typically for proof-of-stake networks supporting validator withdrawals. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_advanced_filtersBlockscout — List transactions, internal transactions and token transfers matching the advanced filter criteriaInspect
Blockscout — List transactions, internal transactions and token transfers matching the advanced filter criteria Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| age_to | No | Inclusive upper bound on `timestamp` (ISO 8601). | |
| methods | No | Comma-separated list of 4-byte contract method selectors (lowercase, `0x`-prefixed). At most 20 unique entries are honored; invalid entries are dropped. | |
| age_from | No | Inclusive lower bound on `timestamp` (ISO 8601). | |
| chain_id | Yes | The ID of the blockchain | |
| amount_to | No | Inclusive upper bound on the item's transferred amount (decimal string in the token's base units). | |
| amount_from | No | Inclusive lower bound on the item's transferred amount (decimal string in the token's base units). | |
| block_number | No | Keyset cursor: block number of the last item from the previous page. | |
| methods_names | No | Comma-separated list of human-readable method names corresponding to the `methods` selectors. | |
| address_relation | No | How to combine the `from_address_hashes_*` and `to_address_hashes_*` filters. Accepts `or` or `and` (case-insensitive). `or` (default) matches an item if either side matches; `and` requires both sides to match. Any other value is silently coerced to `nil` (no relation constraint). | |
| transaction_index | No | Keyset cursor: transaction index within the block of the last item from the previous page. | |
| transaction_types | No | Comma-separated list of transaction types to include. Allowed values: `COIN_TRANSFER`, `CONTRACT_INTERACTION`, `CONTRACT_CREATION`, `ERC-20`, `ERC-404`, `ERC-721`, `ERC-1155`, `ERC-7984` (plus `ZRC-2` on Zilliqa). Values are matched case-insensitively; unknown entries are silently dropped. | |
| token_transfer_index | No | Keyset cursor: token-transfer index of the last item from the previous page. Use an empty string or the literal `null` when the previous item was not a token transfer. Import profile accepts the string branch only; other union branches are not exposed. | |
| internal_transaction_index | No | internal_transaction_index | |
| token_transfer_batch_index | No | Keyset cursor: index within an ERC-1155 batch token transfer. Use an empty string or the literal `null` when the previous item was not part of a batch. Import profile accepts the string branch only; other union branches are not exposed. | |
| to_address_hashes_to_exclude | No | Comma-separated list of recipient address hashes to exclude. | |
| to_address_hashes_to_include | No | Comma-separated list of recipient address hashes to include. | |
| from_address_hashes_to_exclude | No | Comma-separated list of sender address hashes to exclude. | |
| from_address_hashes_to_include | No | Comma-separated list of sender address hashes to include. | |
| token_contract_symbols_to_exclude | No | Comma-separated list of token symbols to exclude. | |
| token_contract_symbols_to_include | No | Comma-separated list of token symbols to include. | |
| token_contract_address_hashes_to_exclude | No | Comma-separated list of token contract address hashes to exclude. Use the literal `native` to also exclude native coin transfers. Each list (include and exclude) is capped to 20 entries separately. | |
| token_contract_address_hashes_to_include | No | Comma-separated list of token contract address hashes to include. Use the literal `native` to also include native coin transfers. Each list (include and exclude) is capped to 20 entries separately. |
blockscout_get_chain_id_api_v2_advanced_filters_methodsBlockscout — List known contract methodsInspect
Returns a list of known contract methods. When the q parameter is provided, searches for a single method by its 4-byte selector or name. Without q, returns the default list of popular methods. Documentation prepared only; runtime not verified.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search string: either a 4-byte method selector (e.g. `0xa9059cbb`) or a method name (e.g. `transfer`). | |
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_arbitrum_batchesBlockscout — List batches.Inspect
Retrieves a paginated list of Arbitrum batches committed to the Parent chain. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| number | No | Number for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| batch_numbers | No | Optional list of specific batch numbers to retrieve. |
blockscout_get_chain_id_api_v2_arbitrum_batches_countBlockscout — Get batches count.Inspect
Retrieves the total count of Arbitrum batches committed to the Parent chain. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_arbitrum_batches_da_anytrust_dataBlockscout — Get batch by AnyTrust data hash.Inspect
Retrieves an Arbitrum batch associated with the given AnyTrust data hash. By default, returns the most recently associated batch. When type=all, returns a paginated list of all batches referencing this data hash. Documentation prepared only; runtime not verified.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | When set to `all`, returns a paginated list of all batches for this data hash. | |
| number | No | Number for paging | |
| chain_id | Yes | The ID of the blockchain | |
| data_hash | Yes | AnyTrust data hash. | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_arbitrum_batches_da_celestia_heigBlockscout — Get batch by Celestia blob reference.Inspect
Retrieves an Arbitrum batch whose data availability blob is identified by the given Celestia block height and transaction commitment hash. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| height | Yes | Celestia block height. | |
| chain_id | Yes | The ID of the blockchain | |
| transaction_commitment | Yes | Celestia transaction commitment hash. |
blockscout_get_chain_id_api_v2_arbitrum_batches_da_eigenda_dataBlockscout — Get batch by EigenDA data hash.Inspect
Retrieves an Arbitrum batch associated with the given EigenDA data hash. By default, returns the most recently associated batch. When type=all, returns a paginated list of all batches referencing this data hash. Documentation prepared only; runtime not verified.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | When set to `all`, returns a paginated list of all batches for this data hash. | |
| number | No | Number for paging | |
| chain_id | Yes | The ID of the blockchain | |
| data_hash | Yes | EigenDA data hash (Keccak-256 of the blob header). | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_arbitrum_messages_claim_message_iBlockscout — Get claim data for a withdrawal.Inspect
Returns the ABI-encoded calldata and outbox contract address required to execute a Rollup withdrawal on the Parent chain. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| message_id | Yes | Withdrawal message ID. |
blockscout_get_chain_id_api_v2_arbitrum_messages_directionBlockscout — List cross-chain messages.Inspect
Retrieves a paginated list of Arbitrum cross-chain messages filtered by the specified direction. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ID for paging | |
| chain_id | Yes | The ID of the blockchain | |
| direction | Yes | Message direction: `from-rollup` for Rollup to Parent chain, `to-rollup` for Parent chain to Rollup. | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_arbitrum_messages_withdrawals_traBlockscout — Get withdrawal messages for a transaction.Inspect
Returns the list of Rollup withdrawal messages (L2ToL1Tx events) emitted by the given transaction. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| transaction_hash | Yes | Transaction hash. |
blockscout_get_chain_id_api_v2_beacon_depositsBlockscout — Lists all beacon depositsInspect
Retrieves a paginated list of all beacon deposits. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Deposit index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_beacon_deposits_countBlockscout — Gets total count of beacon depositsInspect
Retrieves the total count of beacon deposits. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_blocksBlockscout — List blocks with optional filtering by block typeInspect
Retrieves a paginated list of blocks ordered by descending block number. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Filter by block type: * block - Standard blocks in the main chain * uncle - Uncle/ommer blocks (valid but not in main chain) * reorg - Blocks from chain reorganizations If omitted, default value "block" is used. | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging |
blockscout_get_chain_id_api_v2_blocks_arbitrum_batch_batch_numbeBlockscout — List L2 blocks in an Arbitrum batchInspect
Retrieves L2 blocks that are bound to a specific Arbitrum batch number. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| batch_number_param | Yes | Batch number |
blockscout_get_chain_id_api_v2_blocks_block_hash_or_number_par_2Blockscout — Retrieves detailed information for a specific block identified by its number or hash.Inspect
Blockscout — Retrieves detailed information for a specific block identified by its number or hash. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| block_hash_or_number_param | Yes | Block hash or number in the path Import profile accepts the integer branch only; other union branches are not exposed. |
blockscout_get_chain_id_api_v2_blocks_block_hash_or_number_paramBlockscout — List beacon deposits in a specific blockInspect
Retrieves beacon deposits included in a specific block with pagination support. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_hash_or_number_param | Yes | Block hash or number in the path Import profile accepts the integer branch only; other union branches are not exposed. |
blockscout_get_chain_id_api_v2_blocks_optimism_batch_batch_numbeBlockscout — List L2 blocks in an Optimism batchInspect
Retrieves L2 blocks that are bound to a specific Optimism batch number. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| batch_number_param | Yes | Batch number |
blockscout_get_chain_id_api_v2_blocks_scroll_batch_batch_numberBlockscout — List L2 blocks in a Scroll batchInspect
Retrieves L2 blocks that are bound to a specific Scroll batch number. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| batch_number_param | Yes | Batch number |
blockscout_get_chain_id_api_v2_celo_epochsBlockscout — List Celo epochs.Inspect
Retrieves a paginated list of Celo epochs. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| number | No | Number for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_celo_epochs_numberBlockscout — Get Celo epoch details.Inspect
Retrieves detailed information about a Celo epoch. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| number | Yes | Epoch number in the path. | |
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_celo_epochs_number_election_rewarBlockscout — List Celo epoch election rewards.Inspect
Retrieves a paginated list of election rewards for a Celo epoch and reward type. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Reward type in the path. | |
| amount | No | Amount for paging | |
| number | Yes | Epoch number in the path. | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| account_address_hash | No | Account address hash for paging | |
| associated_account_address_hash | No | Associated account address hash for paging |
blockscout_get_chain_id_api_v2_internal_transactionsBlockscout — List internal transactions generated during smart contract executionInspect
Blockscout — List internal transactions generated during smart contract execution Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| limit | No | Limit result items in the response | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| transaction_hash | No | Transaction hash in the query | |
| transaction_index | No | Transaction index for paging |
blockscout_get_chain_id_api_v2_main_page_arbitrum_batches_commitBlockscout — List committed batches on the main page.Inspect
Retrieves a list of Arbitrum batches that have been committed to the Parent chain, displayed on the main page. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_main_page_arbitrum_batches_latestBlockscout — Get the latest batch number.Inspect
Retrieves the number of the most recent Arbitrum batch submitted to the Parent chain. Returns 0 if no batches exist. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_main_page_arbitrum_messages_to_roBlockscout — List recent Parent chain to Rollup messages on the main page.Inspect
Retrieves the most recent relayed messages from Parent chain to Rollup, displayed on the main page. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_main_page_blocksBlockscout — Retrieve recent blocks as displayed on Blockscout homepageInspect
Retrieves a limited set of recent blocks for display on the main page or dashboard. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_main_page_indexing_statusBlockscout — Check if indexing is finished with indexing ratioInspect
Retrieves the current status of blockchain data indexing by the BlockScout instance. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_main_page_optimism_depositsBlockscout — List deposits on the main page.Inspect
Retrieves a list of deposits for the main page. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_main_page_transactionsBlockscout — Retrieve recent transactions as displayed on Blockscout homepageInspect
Retrieves a limited set of recent transactions displayed on the home page. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_optimism_batchesBlockscout — List batches.Inspect
Retrieves a paginated list of batches. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ID for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_optimism_batches_countBlockscout — Number of batches in the list.Inspect
Retrieves a size of the batch list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_optimism_batches_da_celestia_heigBlockscout — Batch by celestia blob.Inspect
Retrieves batch detailed info by the given celestia blob metadata (height and commitment). Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| height | Yes | Celestia blob height in the path. | |
| chain_id | Yes | The ID of the blockchain | |
| commitment | Yes | Celestia blob commitment in the path. |
blockscout_get_chain_id_api_v2_optimism_depositsBlockscout — List deposits.Inspect
Retrieves a paginated list of deposits. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| l1_block_number | No | L1 block number for paging | |
| transaction_hash | No | Transaction hash for paging |
blockscout_get_chain_id_api_v2_optimism_deposits_countBlockscout — Number of deposits in the list.Inspect
Retrieves a size of the deposits list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_optimism_gamesBlockscout — List games.Inspect
Retrieves a paginated list of games. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_optimism_games_countBlockscout — Number of games in the list.Inspect
Retrieves a size of the games list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_optimism_output_rootsBlockscout — List output roots.Inspect
Retrieves a paginated list of output roots. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_optimism_output_roots_countBlockscout — Number of output roots in the list.Inspect
Retrieves a size of the output roots list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_optimism_withdrawalsBlockscout — List withdrawals.Inspect
Retrieves a paginated list of withdrawals. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| nonce | No | Nonce for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_optimism_withdrawals_countBlockscout — Number of withdrawals in the list.Inspect
Retrieves a size of the withdrawals list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_accou_2Blockscout — List of account abstraction walletsInspect
Retrieves a list of account abstraction wallets. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| factory | No | User operation factory address hash | |
| chain_id | Yes | The ID of the blockchain | |
| page_size | No | Number of items returned per page | |
| page_token | No | Page token for paging | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_accountBlockscout — Get an account abstraction wallet by address hashInspect
Retrieves an account abstraction wallet by its address hash. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_bundl_2Blockscout — Get a bundler by address hashInspect
Retrieves a bundler by its address hash. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_bundlerBlockscout — List of top bundlersInspect
Retrieves a list of top bundlers. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| page_size | No | Number of items returned per page | |
| page_token | No | Page token for paging | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_bundlesBlockscout — List of recent bundlesInspect
Retrieves a list of recent bundles. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bundler | No | User operation bundler address hash | |
| chain_id | Yes | The ID of the blockchain | |
| page_size | No | Number of items returned per page | |
| page_token | No | Page token for paging | |
| entry_point | No | User operation entry point address hash | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_facto_2Blockscout — Get a factory by address hashInspect
Retrieves a factory by its address hash. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_factoriBlockscout — List of top wallet factoriesInspect
Retrieves a list of top wallet factories. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| page_size | No | Number of items returned per page | |
| page_token | No | Page token for paging | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_opera_2Blockscout — List of recent user operationsInspect
Retrieves a list of recent user operations. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sender | No | User operation sender address hash | |
| bundler | No | User operation bundler address hash | |
| factory | No | User operation factory address hash | |
| chain_id | Yes | The ID of the blockchain | |
| page_size | No | Number of items returned per page | |
| paymaster | No | User operation paymaster address hash | |
| page_token | No | Page token for paging | |
| entry_point | No | User operation entry point address hash | |
| items_count | No | Number of items per page | |
| block_number | No | User operation block number | |
| bundle_index | No | User operation bundle index | |
| transaction_hash | No | Transaction hash in the query |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_opera_3Blockscout — Get a human-readable, LLM-based user operation summaryInspect
Retrieves a human-readable summary of what a user operation did, presented in natural language. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| just_request_body | No | If true, returns only the request body in the summary endpoint | |
| operation_hash_param | Yes | User operation hash in the path |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_operatiBlockscout — Get a user operation by hashInspect
Retrieves a user operation by its hash. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| operation_hash_param | Yes | User operation hash in the path |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_payma_2Blockscout — List of top paymastersInspect
Retrieves a list of top paymasters. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| page_size | No | Number of items returned per page | |
| page_token | No | Page token for paging | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_paymastBlockscout — Get a paymaster by address hashInspect
Retrieves a paymaster by its address hash. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_proxy_account_abstraction_statusBlockscout — Get the status of the account abstraction microserviceInspect
Retrieves the status of the account abstraction microservice. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_scroll_batchesBlockscout — List batches.Inspect
Retrieves a paginated list of batches. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| number | No | Number for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_scroll_batches_countBlockscout — Number of batches in the list.Inspect
Retrieves a size of the batch list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_scroll_depositsBlockscout — List deposits.Inspect
Retrieves a paginated list of deposits. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ID for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_scroll_deposits_countBlockscout — Number of deposits in the list.Inspect
Retrieves a size of the deposits list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_scroll_withdrawalsBlockscout — List withdrawals.Inspect
Retrieves a paginated list of withdrawals. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ID for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_scroll_withdrawals_countBlockscout — Number of withdrawals in the list.Inspect
Retrieves a size of the withdrawals list. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_searchBlockscout — Search for tokens, addresses, contracts, blocks, or transactions by identifierInspect
Performs a unified search across multiple blockchain entity types including tokens, addresses, contracts, blocks, transactions and other resources. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search query filter | |
| chain_id | Yes | The ID of the blockchain | |
| next_page_params_type | No | Next page params type for paging |
blockscout_get_chain_id_api_v2_search_check_redirectBlockscout — Check if search query should redirect to a specific entity pageInspect
Checks if a search query redirects to a specific entity page rather than showing search results. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search query filter | |
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_search_quickBlockscout — Quick (unpaginated) searchInspect
Performs a quick, unpaginated search for short queries. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search query filter | |
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_shibarium_depositsBlockscout — List Shibarium deposits.Inspect
Retrieves a paginated list of completed Shibarium deposits ordered by parent chain block number descending. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Parent chain block number for paging (cursor on `l1_block_number`). |
blockscout_get_chain_id_api_v2_shibarium_deposits_countBlockscout — Number of Shibarium deposits.Inspect
Retrieves the total count of completed Shibarium deposits. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_shibarium_withdrawalsBlockscout — List Shibarium withdrawals.Inspect
Retrieves a paginated list of completed Shibarium withdrawals ordered by Shibarium block number descending. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Shibarium block number for paging (cursor on `l2_block_number`). |
blockscout_get_chain_id_api_v2_shibarium_withdrawals_countBlockscout — Number of Shibarium withdrawals.Inspect
Retrieves the total count of completed Shibarium withdrawals. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_smart_contractsBlockscout — List verified smart contracts with optional filtering optionsInspect
Retrieves a paginated list of verified smart contracts with optional filtering by proxy status or programming language. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search query filter | |
| hash | No | Address hash for paging | |
| sort | No | Sort results by: * balance - Sort by account balance * transactions_count - Sort by number of transactions Should be used together with `order` parameter. | |
| order | No | Sort order: * asc - Ascending order * desc - Descending order Should be used together with `sort` parameter. | |
| filter | No | Filter to apply | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| coin_balance | No | Coin balance for paging Import profile accepts the integer branch only; other union branches are not exposed. | |
| smart_contract_id | No | Smart-contract ID for paging | |
| transactions_count | No | Transactions count for paging Import profile accepts the integer branch only; other union branches are not exposed. |
blockscout_get_chain_id_api_v2_smart_contracts_address_hash_paraBlockscout — Audit reports listInspect
Returns audit reports for a given smart contract address. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_smart_contracts_countersBlockscout — Get count statistics (new & newly verified) for deployed smart contractsInspect
Retrieves count statistics for smart contracts, including total contracts, verified contracts, and new contracts in the last 24 hours. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_statsBlockscout — Retrieve blockchain network statistics and metricsInspect
Retrieves blockchain network statistics including total blocks, transactions, addresses, average block time, market data, and network utilization. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_stats_charts_marketBlockscout — Get daily closing price and market cap for native coinInspect
Retrieves time series data of market information (daily closing price, market cap) for rendering charts. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_stats_charts_secondary_coin_markeBlockscout — Secondary coin market history chart dataInspect
Returns market history for the secondary coin used for charting. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_stats_charts_transactionsBlockscout — Get daily transaction countsInspect
Retrieves time series data of daily transaction counts for rendering charts. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_stats_hot_smart_contractsBlockscout — Retrieve hot smart-contractsInspect
Retrieves paginated list of hot smart-contracts Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort results by: * transactions_count - Sort by number of transactions * total_gas_used - Sort by total gas used Should be used together with `order` parameter. | |
| order | No | Sort order: * asc - Ascending order * desc - Descending order Should be used together with `sort` parameter. | |
| scale | Yes | Time scale for hot contracts aggregation (5m=5 minutes, 1h=1 hour, 3h=3 hours, 1d=1 day, 7d=7 days, 30d=30 days) | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| total_gas_used | No | Total gas used for paging | |
| transactions_count | No | Transactions count for paging | |
| contract_address_hash | No | Contract address hash for paging |
blockscout_get_chain_id_api_v2_tokensBlockscout — List tokens with optional filtering by name, symbol, or typeInspect
Retrieves a paginated list of tokens with optional filtering by name, symbol, or type. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search query filter | |
| name | No | Name for paging | |
| sort | No | Sort results by: * fiat_value - Sort by fiat value * holders_count - Sort by number of token holders * circulating_market_cap - Sort by circulating market cap of the token Should be used together with `order` parameter. | |
| type | No | Filter by token type. Comma-separated list of: * ERC-20 - Fungible tokens * ERC-721 - Non-fungible tokens * ERC-1155 - Multi-token standard * ERC-404 - Hybrid fungible/non-fungible tokens Example: `ERC-20,ERC-721` to show both fungible and NFT transfers Import profile accepts the string branch only; other union branches are not exposed. | |
| limit | No | Limit result items in the response | |
| order | No | Sort order: * asc - Ascending order * desc - Descending order Should be used together with `sort` parameter. | |
| chain_id | Yes | The ID of the blockchain | |
| fiat_value | No | Fiat value for paging Import profile accepts the string branch only; other union branches are not exposed. | |
| market_cap | No | Market cap for paging Import profile accepts the string branch only; other union branches are not exposed. | |
| items_count | No | Number of items per page | |
| is_name_null | No | Is name null for paging | |
| holders_count | No | Number of holders returned per page Import profile accepts the string branch only; other union branches are not exposed. | |
| contract_address_hash | No | Contract address hash for paging |
blockscout_get_chain_id_api_v2_tokens_address_hash_paramBlockscout — Retrieve detailed information about a specific tokenInspect
Retrieves detailed information for a specific token identified by its contract address. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_counterBlockscout — Get holder and transfer count statistics for a specific tokenInspect
Retrieves count statistics for a specific token, including holders count and transfers count. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_holdersBlockscout — List addresses holding a specific token sorted by balanceInspect
Retrieves addresses holding a specific token, sorted by balance. Useful for analyzing token distribution. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| value | No | Transaction value for paging Import profile accepts the string branch only; other union branches are not exposed. | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| address_hash | No | Address hash for paging | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_2Blockscout — Get total number of ownership transfers for a specific NFTInspect
Retrieves the total number of transfers for a specific NFT instance. Useful for determining how frequently an NFT has changed hands. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| token_id_param | Yes | Token ID for ERC-721/1155/404 tokens | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_3Blockscout — List token transfers for a specific token instanceInspect
Retrieves token transfers for a specific token instance (by token address and token ID). Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| token_id | No | Token ID for paging | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| token_id_param | Yes | Token ID for ERC-721/1155/404 tokens | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_4Blockscout — Fetch media type for a specific NFT instanceInspect
Determines and returns the media type categories (image/video/html) for the image and animation URLs of a specific NFT instance. Fetches via HTTP HEAD if not yet determined and stores the result. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| token_id_param | Yes | Token ID for ERC-721/1155/404 tokens | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_5Blockscout — List individual NFT instances for a token contractInspect
Retrieves instances of NFTs for a specific token contract. This endpoint is primarily for ERC-721 and ERC-1155 tokens. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| unique_token | No | Token ID for paging | |
| address_hash_param | Yes | Address hash in the path | |
| holder_address_hash | No | Token holder address hash in the query |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_6Blockscout — Retrieve detailed information about a specific NFTInspect
Retrieves detailed information about a specific NFT instance, identified by its token contract address and token ID. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| token_id_param | Yes | Token ID for ERC-721/1155/404 tokens | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_instancBlockscout — List current holders of a specific NFTInspect
Retrieves current holders of a specific NFT instance. For ERC-721, this will typically be a single address. For ERC-1155, multiple addresses may hold the same token ID. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| value | No | Transaction value for paging Import profile accepts the string branch only; other union branches are not exposed. | |
| chain_id | Yes | The ID of the blockchain | |
| token_id | No | Token ID for paging | |
| items_count | No | Number of items per page | |
| address_hash | No | Address hash for paging | |
| token_id_param | Yes | Token ID for ERC-721/1155/404 tokens | |
| address_hash_param | Yes | Address hash in the path |
blockscout_get_chain_id_api_v2_tokens_address_hash_param_transfeBlockscout — List ownership transfer history for a specific NFTInspect
Retrieves transfer history for a specific NFT instance, showing ownership changes over time. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| index_in_batch | No | Index in batch for paging | |
| batch_log_index | No | Batch log index for paging | |
| batch_block_hash | No | Batch block hash for paging | |
| address_hash_param | Yes | Address hash in the path | |
| batch_transaction_hash | No | Batch transaction hash for paging |
blockscout_get_chain_id_api_v2_token_transfersBlockscout — List token transfers across all token types (ERC-20, ERC-721, ERC-1155)Inspect
Retrieves a paginated list of token transfers across all token types (ERC-20, ERC-721, ERC-1155). Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Filter by token type. Comma-separated list of: * ERC-20 - Fungible tokens * ERC-721 - Non-fungible tokens * ERC-1155 - Multi-token standard * ERC-404 - Hybrid fungible/non-fungible tokens Example: `ERC-20,ERC-721` to show both fungible and NFT transfers Import profile accepts the string branch only; other union branches are not exposed. | |
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| index_in_batch | No | Index in batch for paging | |
| batch_log_index | No | Batch log index for paging | |
| batch_block_hash | No | Batch block hash for paging | |
| batch_transaction_hash | No | Batch transaction hash for paging |
blockscout_get_chain_id_api_v2_transactionsBlockscout — List blockchain transactions with filtering options for status, type, and methodInspect
Retrieves a paginated list of transactions with optional filtering by status, type, and method. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| hash | No | Transaction hash for paging | |
| type | No | Filter by transaction type. Comma-separated list of: * blob_transaction - Only show blob transactions | |
| index | No | Item index for paging | |
| filter | No | Filter transactions by status: * pending - Transactions waiting to be mined/validated * validated - Confirmed transactions included in blocks If omitted, default value "validated" is used. | |
| chain_id | Yes | The ID of the blockchain | |
| inserted_at | No | Inserted at timestamp for paging (ISO8601) | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging |
blockscout_get_chain_id_api_v2_transactions_arbitrum_batch_batchBlockscout — List L2 transactions in an Arbitrum batchInspect
Retrieves L2 transactions bound to a specific Arbitrum batch number. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| batch_number_param | Yes | Batch number |
blockscout_get_chain_id_api_v2_transactions_optimism_batch_batchBlockscout — List L2 transactions in an Optimism batchInspect
Retrieves L2 transactions bound to a specific Optimism batch number. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| batch_number_param | Yes | Batch number |
blockscout_get_chain_id_api_v2_transactions_scroll_batch_batch_nBlockscout — List L2 transactions in a Scroll batchInspect
Retrieves L2 transactions bound to a specific Scroll batch number. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| block_number | No | Block number for paging | |
| batch_number_param | Yes | Batch number |
blockscout_get_chain_id_api_v2_transactions_statsBlockscout — Get transaction statisticsInspect
Retrieves statistics for transactions, including counts and fee summaries for the last 24 hours. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_transactions_transaction_hash_parBlockscout — List beacon deposits in a transactionInspect
Retrieves beacon deposits included in a specific transaction with pagination support. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page | |
| transaction_hash_param | Yes | Transaction hash in the path |
blockscout_get_chain_id_api_v2_validators_stabilityBlockscout — List Stability validators.Inspect
Retrieves a paginated list of validators on the Stability chain, optionally filtered by state and sorted by state, address hash or number of blocks produced. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort results by: * state - Sort by validator operational state * address_hash - Sort by address hash * blocks_validated - Sort by number of blocks validated by the validator Should be used together with `order` parameter. | |
| order | No | Sort order: * asc - Ascending order * desc - Descending order Should be used together with `sort` parameter. | |
| state | No | Cursor field — validator state from the previous page's `next_page_params`. | |
| chain_id | Yes | The ID of the blockchain | |
| address_hash | No | Cursor field — validator address hash from the previous page's `next_page_params`. | |
| state_filter | No | Comma-separated list of validator states to keep. Allowed values: `active`, `probation`, `inactive` (case-sensitive). | |
| blocks_validated | No | Cursor field — number of blocks validated from the previous page's `next_page_params`. |
blockscout_get_chain_id_api_v2_validators_stability_countersBlockscout — Get Stability validators counters.Inspect
Retrieves aggregate counters for the Stability chain validator set. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
blockscout_get_chain_id_api_v2_validators_zilliqaBlockscout — Zilliqa validators list.Inspect
Retrieves the list of Zilliqa validators. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort results by: * index - Sort by validator index Should be used together with `order` parameter. | |
| index | No | Item index for paging | |
| order | No | Sort order: * asc - Ascending order * desc - Descending order Should be used together with `sort` parameter. | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_validators_zilliqa_bls_public_keyBlockscout — Zilliqa validator by its BLS public key.Inspect
Retrieves Zilliqa validator detailed info by the given BLS public key. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain | |
| bls_public_key | Yes | bls_public_key |
blockscout_get_chain_id_api_v2_withdrawalsBlockscout — List validator withdrawal details on proof-of-stake networksInspect
Retrieves a paginated list of withdrawals, typically for proof-of-stake networks supporting validator withdrawals. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Item index for paging | |
| chain_id | Yes | The ID of the blockchain | |
| items_count | No | Number of items per page |
blockscout_get_chain_id_api_v2_withdrawals_countersBlockscout — Withdrawals countersInspect
Returns total withdrawals count and sum from cache. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The ID of the blockchain |
coingecko_extra_get_api_v3_coins_idCoinGecko — Coin Data by IDInspect
To query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin based on a particular coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Coin ID. *refers to [`/coins/list`](/reference/coins-list) | |
| tickers | No | Include tickers data. Default: true | |
| sparkline | No | Include sparkline 7-day data. Default: false | |
| market_data | No | Include market data. Default: true | |
| localization | No | Include all localized languages in the response. Default: true | |
| community_data | No | Include community data. Deprecated: has no effect as of 28 August 2026; the `community_data` object is no longer returned. | |
| developer_data | No | Include developer data. Deprecated: has no effect as of 28 August 2026; the `developer_data` object is no longer returned. | |
| dex_pair_format | No | Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` | |
| include_categories_details | No | Include categories details. Default: false |
coingecko_extra_get_api_v3_derivatives_exchanges_idCoinGecko — Derivatives Exchange Data by IDInspect
To query the derivatives exchange's related data (name, open interest, trade volume, ...) based on the exchange's ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Derivative exchange ID. *refers to [`/derivatives/exchanges/list`](/reference/derivatives-exchanges-list). | |
| include_tickers | No | Include tickers data. Default: tickers data is not included. |
coingecko_extra_get_api_v3_entity_public_treasury_coin_idCoinGecko — Crypto Treasury Holdings by Coin IDInspect
To query public companies' and governments' cryptocurrency holdings by coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| order | No | Sort order for results. Default: `total_holdings_usd_desc` | |
| entity | Yes | Public company or government entity. | |
| coin_id | Yes | Coin ID. e.g. `bitcoin`, `ethereum`, `solana`, `binancecoin` | |
| per_page | No | Total results per page. Default value: 250 Valid values: 1...250 |
coingecko_extra_get_api_v3_exchanges_idCoinGecko — Exchange Data by IDInspect
To query exchange's data (name, year established, country, etc.), exchange volume in BTC and top 100 tickers based on exchange's ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Exchange ID. *refers to [`/exchanges/list`](/reference/exchanges-list). | |
| dex_pair_format | No | Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` |
coingecko_extra_get_api_v3_nfts_idCoinGecko — NFTs Collection Data by IDInspect
To query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | NFT collection ID. *refers to [`/nfts/list`](/reference/nfts-list). |
coingecko_extra_get_api_v3_onchain_networks_network_pools_pool_2CoinGecko — Pool Tokens Info by Pool AddressInspect
To query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | Attributes to include. | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| pool_address | Yes | Pool contract address. |
coingecko_extra_get_api_v3_onchain_networks_network_pools_pool_aCoinGecko — Trades by Pool AddressInspect
To query the trades based on the provided pool address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token | No | Return trades for token, use this to invert the chart. Available values: `base`, `quote`, or token address. Default: `base` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| pool_address | Yes | Pool contract address. | |
| include_anomalous | No | Include trades flagged as anomalous. Default: `false` | |
| trade_volume_in_usd_greater_than | No | Filter trades by trade volume in USD greater than this value. Default value: 0 |
coingecko_extra_get_api_v3_onchain_networks_network_tokens_multiCoinGecko — Tokens Data by Token AddressesInspect
To query multiple tokens data based on the provided token contract addresses on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | Attributes to include. | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| addresses | Yes | Token contract address, comma-separated if more than one token contract address. | |
| include_composition | No | Include pool composition. Default: `false` | |
| include_inactive_source | No | Include tokens from inactive pools using the most recent swap. Default: `false` |
coingecko_extra_get_api_v3_rwas_idCoinGecko — RWA Data by IDInspect
To query all the metadata, market data and tokens of a RWA based on a particular RWA ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | RWA ID. *refers to [`/rwas/list`](/reference/rwas-list) | |
| tokens | No | Include tokens data. Default: false | |
| sparkline | No | Include sparkline 7-day data. Default: false | |
| perps_market_data | No | Include perpetuals market data. Default: false | |
| tokenized_market_data | No | Include tokenized market data. Default: false |
coingecko_extra_get_api_v3_rwas_issuers_idCoinGecko — RWA Issuer Data by IDInspect
To query the market data (market cap, volume, etc.) and tokens of an issuer based on a particular issuer ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Issuer ID. *refers to [`/rwas/issuers/list`](/reference/rwas-issuers-list) |
coingecko_get_api_v3_asset_platformsCoinGecko — Asset Platforms ListInspect
To query all the supported asset platforms (blockchain networks) on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Apply relevant filters to results. |
coingecko_get_api_v3_coins_categoriesCoinGecko — Coins Categories List with Market DataInspect
To query all the coins categories with market data (market cap, volume, etc.) on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order | No | Sort results by field. Default: `market_cap_desc` |
coingecko_get_api_v3_coins_categories_listCoinGecko — Coins Categories ListInspect
To query all the supported coins categories on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_coins_id_contract_contract_addressCoinGecko — Coin Data by Token AddressInspect
To query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin based on an asset platform and a particular token contract address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Asset platform ID. *refers to [`/asset_platforms`](/reference/asset-platforms-list). | |
| contract_address | Yes | The contract address of token. |
coingecko_get_api_v3_coins_id_contract_contract_address_market_2CoinGecko — Coin Historical Chart Data within Time Range by Token AddressInspect
To get the historical chart data within certain time range in UNIX along with price, market cap and 24hrs volume based on asset platform and particular token contract address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Asset platform ID. *refers to [`/asset_platforms`](/reference/asset-platforms-list). | |
| to | Yes | Ending date in UNIX timestamp. | |
| from | Yes | Starting date in UNIX timestamp. | |
| precision | No | Decimal place for currency price value. | |
| vs_currency | Yes | Target currency of market data. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). | |
| contract_address | Yes | The contract address of token. |
coingecko_get_api_v3_coins_id_contract_contract_address_market_cCoinGecko — Coin Historical Chart Data by Token AddressInspect
To get the historical chart data including time in UNIX, price, market cap and 24hrs volume based on asset platform and particular token contract address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Asset platform ID. *refers to [`/asset_platforms`](/reference/asset-platforms-list). | |
| days | Yes | Data up to number of days ago. You may use any integer or `max` for number of days. | |
| interval | No | Data interval, leave empty for auto granularity. | |
| precision | No | Decimal place for currency price value. | |
| vs_currency | Yes | Target currency of market data. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). | |
| contract_address | Yes | The contract address of token. |
coingecko_get_api_v3_coins_id_historyCoinGecko — Coin Historical Data by IDInspect
To query the historical data (price, market cap, 24hrs volume, etc.) at a given date for a coin based on a particular coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Coin ID. *refers to [`/coins/list`](/reference/coins-list). | |
| date | Yes | The date of data snapshot. Format: `dd-mm-yyyy` | |
| localization | No | Include all the localized languages in response. Default: true |
coingecko_get_api_v3_coins_id_market_chartCoinGecko — Coin Historical Chart Data by IDInspect
To get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on particular coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Coin ID. *refers to [`/coins/list`](/reference/coins-list). | |
| days | Yes | Data up to number of days ago. You may use any integer or `max` for number of days. | |
| interval | No | Data interval, leave empty for auto granularity. | |
| precision | No | Decimal place for currency price value. | |
| vs_currency | Yes | Target currency of market data. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). |
coingecko_get_api_v3_coins_id_market_chart_rangeCoinGecko — Coin Historical Chart Data within Time Range by IDInspect
To get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on particular coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Coin ID. *refers to [`/coins/list`](/reference/coins-list). | |
| to | Yes | Ending date in UNIX timestamp. | |
| from | Yes | Starting date in UNIX timestamp. | |
| interval | No | Data interval, leave empty for auto granularity. | |
| precision | No | Decimal place for currency price value. | |
| vs_currency | Yes | Target currency of market data. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). |
coingecko_get_api_v3_coins_id_ohlcCoinGecko — Coin OHLC Chart by IDInspect
To get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Coin ID. *refers to [`/coins/list`](/reference/coins-list). | |
| days | Yes | Data up to number of days ago. | |
| precision | No | Decimal place for currency price value. | |
| vs_currency | Yes | Target currency of price data. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). |
coingecko_get_api_v3_coins_id_tickersCoinGecko — Coin Tickers by IDInspect
To query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Coin ID. *refers to [`/coins/list`](/reference/coins-list) | |
| page | No | Page through results | |
| depth | No | Include 2% orderbook depth, i.e. `cost_to_move_up_usd` and `cost_to_move_down_usd`. Default: false | |
| order | No | Sort the order of responses. Default: trust_score_desc | |
| exchange_ids | No | Exchange ID. *refers to [`/exchanges/list`](/reference/exchanges-list) | |
| dex_pair_format | No | Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` | |
| include_exchange_logo | No | Include exchange logo. Default: false |
coingecko_get_api_v3_coins_listCoinGecko — Coins ListInspect
To query all the supported coins on CoinGecko with coin ID, name and symbol Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter by status of coins. Default: active | |
| include_platform | No | Include platform and token's contract addresses. Default: false |
coingecko_get_api_v3_coins_marketsCoinGecko — Coins List with Market DataInspect
To query all the supported coins with price, market cap, volume and market related data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Coins' IDs, comma-separated if querying more than 1 coin. *refers to [`/coins/list`](/reference/coins-list) | |
| page | No | Page through results. Default: 1 | |
| names | No | Coins' names, comma-separated if querying more than 1 coin. | |
| order | No | Sort result by field. Default: market_cap_desc | |
| locale | No | Language background. Default: en | |
| symbols | No | Coins' symbols, comma-separated if querying more than 1 coin. | |
| category | No | Filter based on coins' category. *refers to [`/coins/categories/list`](/reference/coins-categories-list) | |
| per_page | No | Total results per page. Default: 100 Valid values: 1...250 | |
| precision | No | Decimal places for currency price value | |
| sparkline | No | Include sparkline 7-day data. Default: false | |
| vs_currency | Yes | Target currency of coins and market data. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) | |
| include_tokens | No | For `symbols` lookups, specify `all` to include all matching tokens. Default `top` returns top-ranked tokens by market cap or volume. | |
| include_rehypothecated | No | Include rehypothecated tokens in results. When true, returns `market_cap_rank_with_rehypothecated` field. Default: false | |
| price_change_percentage | No | Include price change percentage timeframe, comma-separated if querying more than 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `200d`, `1y` |
coingecko_get_api_v3_derivativesCoinGecko — Derivatives Tickers ListInspect
To query all the tickers from derivatives exchanges on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_derivatives_exchangesCoinGecko — Derivatives Exchanges List with DataInspect
To query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| order | No | Sort order of responses. Default: `open_interest_btc_desc` | |
| per_page | No | Total results per page. |
coingecko_get_api_v3_derivatives_exchanges_listCoinGecko — Derivatives Exchanges ListInspect
To query all the supported derivatives exchanges with ID and name on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_entities_listCoinGecko — Entities ListInspect
To query all the supported entities on CoinGecko with entity ID, name, symbol, and country Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| per_page | No | Total results per page. Default value: 100 Valid values: 1...250 | |
| entity_type | No | Filter by entity type. |
coingecko_get_api_v3_exchange_ratesCoinGecko — BTC-to-Currency Exchange RatesInspect
To query BTC exchange rates with other currencies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_exchangesCoinGecko — Exchanges List with DataInspect
To query all the supported exchanges with exchanges' data (ID, name, country, etc.) that have active trading volumes on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default: 1 | |
| per_page | No | Total results per page. Default: 100. Valid values: 1...250 |
coingecko_get_api_v3_exchanges_id_tickersCoinGecko — Exchange Tickers by IDInspect
To query exchange's tickers based on exchange's ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Exchange ID. *refers to [`/exchanges/list`](/reference/exchanges-list). | |
| page | No | Page through results. | |
| depth | No | Include 2% orderbook depth (cost_to_move_up_usd and cost_to_move_down_usd). Default: false | |
| order | No | Sort the order of responses. Default: `trust_score_desc` | |
| coin_ids | No | Filter tickers by coin IDs, comma-separated if querying more than 1 coin. *refers to [`/coins/list`](/reference/coins-list). | |
| dex_pair_format | No | Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` | |
| include_exchange_logo | No | Include exchange logo. Default: false |
coingecko_get_api_v3_exchanges_id_volume_chartCoinGecko — Exchange Volume Chart by IDInspect
To query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Exchange ID or derivative exchange ID. *refers to [`/exchanges/list`](/reference/exchanges-list) or [`/derivatives/exchanges/list`](/reference/derivatives-exchanges-list). | |
| days | Yes | Data up to number of days ago. |
coingecko_get_api_v3_exchanges_listCoinGecko — Exchanges ListInspect
To query all the supported exchanges with ID and name Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter by status of exchanges. Default: `active` |
coingecko_get_api_v3_globalCoinGecko — Crypto Global Market DataInspect
To query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_global_decentralized_finance_defiCoinGecko — Global DeFi Market DataInspect
To query top 100 cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_nfts_asset_platform_id_contract_contract_adCoinGecko — NFTs Collection Data by Contract AddressInspect
To query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| contract_address | Yes | Contract address of the NFT collection. | |
| asset_platform_id | Yes | Asset platform ID. *refers to [`/asset_platforms`](/reference/asset-platforms-list). |
coingecko_get_api_v3_nfts_listCoinGecko — NFTs ListInspect
To query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. | |
| order | No | Sort order of responses. | |
| per_page | No | Total results per page. Valid values: 1...250 |
coingecko_get_api_v3_onchain_networksCoinGecko — Networks ListInspect
To retrieve a list of all supported networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 |
coingecko_get_api_v3_onchain_networks_network_dexesCoinGecko — DEXs List by NetworkInspect
To query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). |
coingecko_get_api_v3_onchain_networks_network_dexes_dex_poolsCoinGecko — Top Pools by DEXInspect
To query all the top pools based on the provided network and decentralized exchange (DEX) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dex | Yes | DEX ID. *refers to [`/onchain/networks/{network}/dexes`](/reference/dexes-list). | |
| page | No | Page through results. Default value: 1 | |
| sort | No | Sort the pools by field. Default: `h24_tx_count_desc` | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| include_gt_community_data | No | Include GeckoTerminal community data (sentiment votes, suspicious reports). Default: `false` |
coingecko_get_api_v3_onchain_networks_network_new_poolsCoinGecko — New Pools by NetworkInspect
To query all the latest pools based on the provided network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| include_gt_community_data | No | Include GeckoTerminal community data (sentiment votes, suspicious reports). Default: `false` |
coingecko_get_api_v3_onchain_networks_network_poolsCoinGecko — Top Pools by NetworkInspect
To query all the top pools based on the provided network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| sort | No | Sort the pools by field. Default: `h24_tx_count_desc` | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| include_gt_community_data | No | Include GeckoTerminal community data (sentiment votes, suspicious reports). Default: `false` |
coingecko_get_api_v3_onchain_networks_network_pools_addressCoinGecko — Specific Pool Data by Pool AddressInspect
To query the specific pool based on the provided network and pool address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Pool address. | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| include_composition | No | Include pool composition. Default: `false` | |
| include_volume_breakdown | No | Include volume breakdown. Default: `false` |
coingecko_get_api_v3_onchain_networks_network_pools_multi_addresCoinGecko — Multiple Pools Data by Pool AddressesInspect
To query multiple pools based on the provided network and pool addresses Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| addresses | Yes | Pool contract address, comma-separated if more than one pool contract address. | |
| include_composition | No | Include pool composition. Default: `false` | |
| include_volume_breakdown | No | Include volume breakdown. Default: `false` |
coingecko_get_api_v3_onchain_networks_network_pools_pool_addressCoinGecko — Pool OHLCV Chart by Pool AddressInspect
To get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of OHLCV results to return, maximum 1000. Default value: 100 | |
| token | No | Return OHLCV for token, use this to invert the chart. Available values: `base`, `quote`, or token address. Default: `base` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| currency | No | Return OHLCV in USD or quote token. Default: `usd` | |
| aggregate | No | Time period to aggregate each OHLCV. Available values (day): `1` Available values (hour): `1`, `4`, `12` Available values (minute): `1`, `5`, `15` Default value: 1 | |
| timeframe | Yes | Timeframe of the OHLCV chart. | |
| pool_address | Yes | Pool contract address. | |
| before_timestamp | No | Return OHLCV data before this timestamp (integer seconds since epoch). | |
| include_empty_intervals | No | Include empty intervals with no trade data. Default: `false` |
coingecko_get_api_v3_onchain_networks_network_tokens_addressCoinGecko — Token Data by Token AddressInspect
To query specific token data based on the provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Token contract address. | |
| include | No | Attributes to include. | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| include_composition | No | Include pool composition. Default: `false` | |
| include_inactive_source | No | Include token data from inactive pools using the most recent swap. Default: `false` |
coingecko_get_api_v3_onchain_networks_network_tokens_address_infCoinGecko — Token Info by Token AddressInspect
To query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Token contract address. | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). |
coingecko_get_api_v3_onchain_networks_network_tokens_token_addreCoinGecko — Top Pools by Token AddressInspect
To query top pools based on the provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| sort | No | Sort the pools by field. Default: `h24_volume_usd_liquidity_desc` | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| token_address | Yes | Token contract address. | |
| include_inactive_source | No | Include tokens from inactive pools using the most recent swap. Default: `false` | |
| include_gt_community_data | No | Include GeckoTerminal community data (sentiment votes, suspicious reports). Default: `false` |
coingecko_get_api_v3_onchain_networks_network_trending_poolsCoinGecko — Trending Pools by NetworkInspect
To query the trending pools based on the provided network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| duration | No | Duration to sort trending list by. Default: `24h` | |
| include_gt_community_data | No | Include GeckoTerminal community data (sentiment votes, suspicious reports). Default: `false` |
coingecko_get_api_v3_onchain_networks_new_poolsCoinGecko — New Pools ListInspect
To query all the latest pools across all networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex`, `network` | |
| include_gt_community_data | No | Include GeckoTerminal community data (sentiment votes, suspicious reports). Default: `false` |
coingecko_get_api_v3_onchain_networks_trending_poolsCoinGecko — Trending Pools ListInspect
To query all the trending pools across all networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex`, `network` | |
| duration | No | Duration to sort trending list by. Default: `24h` | |
| include_gt_community_data | No | Include GeckoTerminal community data (sentiment votes, suspicious reports). Default: `false` |
coingecko_get_api_v3_onchain_search_poolsCoinGecko — Search Pools & TokensInspect
To search for pools across all networks by pool address, token name, token symbol, or token contract address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| query | No | Search query: pool contract address, token name, token symbol, or token contract address. | |
| include | No | Attributes to include, comma-separated if more than one. Available values: `base_token`, `quote_token`, `dex` | |
| network | No | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). |
coingecko_get_api_v3_onchain_simple_networks_network_token_priceCoinGecko — Token Price by Token AddressesInspect
To get token price based on the provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| network | Yes | Network ID. *refers to [`/onchain/networks`](/reference/networks-list). | |
| addresses | Yes | Token contract address, comma-separated if more than one token contract address. | |
| include_24hr_vol | No | Include 24hr volume. Default: `false` | |
| mcap_fdv_fallback | No | Return FDV if market cap is not available. Default: `false` | |
| include_market_cap | No | Include market capitalization. Default: `false` | |
| include_inactive_source | No | Include token price data from inactive pools using the most recent swap. Default: `false` | |
| include_24hr_price_change | No | Include 24hr price change. Default: `false` | |
| include_total_reserve_in_usd | No | Include total reserve in USD. Default: `false` |
coingecko_get_api_v3_onchain_tokens_info_recently_updatedCoinGecko — Most Recently Updated Tokens ListInspect
To query 100 most recently updated tokens info of a specific network or across all networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | Attributes for related resources to include. | |
| network | No | Filter tokens by provided network. *refers to [`/onchain/networks`](/reference/networks-list). |
coingecko_get_api_v3_public_treasury_entity_idCoinGecko — Crypto Treasury Holdings by Entity IDInspect
To query public companies' and governments' cryptocurrency holdings by entity ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | Yes | Public company or government entity ID. *refers to [`/entities/list`](/reference/entities-list). | |
| holding_amount_change | No | Include holding amount change for specified timeframes, comma-separated if querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, `ytd` | |
| holding_change_percentage | No | Include holding change percentage for specified timeframes, comma-separated if querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, `ytd` |
coingecko_get_api_v3_public_treasury_entity_id_coin_id_holding_cCoinGecko — Crypto Treasury Holdings Historical Chart Data by IDInspect
To query historical cryptocurrency holdings chart of public companies and governments by entity ID and coin ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| days | Yes | Data up to number of days ago. Valid values: `7`, `14`, `30`, `90`, `180`, `365` | |
| coin_id | Yes | Coin ID. e.g. `bitcoin`, `ethereum`, `solana`, `binancecoin` | |
| entity_id | Yes | Public company or government entity ID. *refers to [`/entities/list`](/reference/entities-list). | |
| include_empty_intervals | No | Include empty intervals with no transaction data. Default: `false` |
coingecko_get_api_v3_public_treasury_entity_id_transaction_histoCoinGecko — Crypto Treasury Transaction History by Entity IDInspect
To query public companies' and governments' cryptocurrency transaction history by entity ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page through results. Default value: 1 | |
| order | No | Sort order of transactions. Default: `date_desc` | |
| coin_ids | No | Filter transactions by coin IDs, comma-separated if querying more than 1 coin. *refers to [`/coins/list`](/reference/coins-list). | |
| per_page | No | Total results per page. Default value: 100 Valid values: 1...250 | |
| entity_id | Yes | Public company or government entity ID. *refers to [`/entities/list`](/reference/entities-list). |
coingecko_get_api_v3_rwas_issuers_listCoinGecko — RWA Issuers ListInspect
To query all the supported RWA issuers on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_rwas_listCoinGecko — RWA ListInspect
To query all the supported tokenized real world assets (RWAs) on CoinGecko with RWA ID, name and symbol Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| asset_type | No | Filter by RWA asset type. |
coingecko_get_api_v3_rwas_marketsCoinGecko — RWA List with Market DataInspect
To query all the supported RWAs with price, market cap, volume and market related data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | RWAs' IDs, comma-separated if querying more than 1 RWA. *refers to [`/rwas/list`](/reference/rwas-list) | |
| page | No | Page through results. Default: 1 | |
| names | No | RWAs' names, comma-separated if querying more than 1 RWA. | |
| order | No | Sort result by field. Default: market_cap_desc | |
| issuer | No | Filter based on RWAs' issuer. *refers to [`/rwas/issuers/list`](/reference/rwas-issuers-list) | |
| symbols | No | RWAs' symbols, comma-separated if querying more than 1 RWA. | |
| per_page | No | Total results per page. Default: 100 Valid values: 1...250 | |
| precision | No | Decimal places for currency price value | |
| sparkline | No | Include sparkline 7-day data. Default: false | |
| asset_type | No | Filter by RWA asset type. | |
| price_change_percentage | No | Include price change percentage timeframe, comma-separated if querying more than 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `200d`, `1y` |
coingecko_get_api_v3_searchCoinGecko — Search QueriesInspect
To search for coins, categories and markets listed on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query |
coingecko_get_api_v3_search_trendingCoinGecko — Trending Search ListInspect
To query trending search coins, NFTs and categories on CoinGecko in the last 24 hours Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_simple_priceCoinGecko — Coin Price by IDs, Symbols, or NamesInspect
To query the prices of one or more coins by using their unique Coin API IDs, symbols, or names Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Coins' IDs, comma-separated if querying more than 1 coin. *refers to [`/coins/list`](/reference/coins-list) | |
| names | No | Coins' names, comma-separated if querying more than 1 coin. | |
| symbols | No | Coins' symbols, comma-separated if querying more than 1 coin. | |
| precision | No | Decimal places for currency price value | |
| vs_currencies | Yes | Target currency of coins, comma-separated if querying more than 1 currency. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). For the complete list of fiat currencies supported by this endpoint, see [Fiat Currencies Support List](/docs/fiat-currencies-support). | |
| include_tokens | No | For `symbols` lookups, specify `all` to include all matching tokens. Default `top` returns top-ranked tokens by market cap or volume. | |
| include_24hr_vol | No | Include 24-hour trading volume. Default: false | |
| include_market_cap | No | Include market capitalization. Default: false | |
| include_24hr_change | No | Include 24-hour change percentage. Default: false | |
| include_last_updated_at | No | Include last updated price time as a UNIX timestamp. Default: false |
coingecko_get_api_v3_simple_supported_vs_currenciesCoinGecko — Currencies ListInspect
To query all the supported currencies on CoinGecko Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
coingecko_get_api_v3_simple_token_price_idCoinGecko — Coin Price by Token AddressesInspect
To query one or more token prices by using their token contract addresses Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Asset platform's ID. *refers to [`/asset_platforms`](/reference/asset-platforms-list) | |
| precision | No | Decimal places for currency price value | |
| vs_currencies | Yes | Target currency of coins, comma-separated if querying more than 1 currency. *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). For the complete list of fiat currencies supported by this endpoint, see [Fiat Currencies Support List](/docs/fiat-currencies-support). | |
| include_24hr_vol | No | Include 24-hour trading volume. Default: false | |
| contract_addresses | Yes | Token contract addresses, comma-separated if querying more than 1 token | |
| include_market_cap | No | Include market capitalization. Default: false | |
| include_24hr_change | No | Include 24-hour change percentage. Default: false | |
| include_last_updated_at | No | Include last updated price time as a UNIX timestamp. Default: false |
coingecko_get_api_v3_token_lists_asset_platform_id_all_jsonCoinGecko — Token Lists by Asset Platform IDInspect
To get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| asset_platform_id | Yes | Asset platform ID. *refers to [`/asset_platforms`](/reference/asset-platforms-list). |
context_dev_get_v1_web_fontsContext.dev — Scrape FontsInspect
Detect the fonts a website uses, with usage statistics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both. | |
| maxAgeMs | No | Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1 year. `0` refreshes. | |
| directUrl | No | Exact page to inspect. Provide either `domain` or `directUrl`. |
context_dev_get_v1_web_scrape_sitemapContext.dev — Crawl SitemapInspect
Discover every URL in a website's sitemap. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| zdr | No | `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless your organization has ZDR. | |
| domain | Yes | Domain to map, e.g. `stripe.com`. | |
| search | No | Filter URLs by a topic or phrase, most relevant first. | |
| maxLinks | No | Maximum number of URLs to return. | |
| urlRegex | No | Regex pattern. Only URLs matching this pattern are returned and counted against maxLinks. | |
| sitemapUrl | No | Fetch this sitemap instead of discovering sitemaps. Must belong to the domain or a subdomain. | |
| excludeUrlRegex | No | Regex pattern. URLs matching this pattern are not returned, even when they match urlRegex. | |
| includeSubdomains | No | Include URLs on subdomains. |
context_dev_get_v1_web_styleguideContext.dev — Extract StyleguideInspect
Extract a website's design system: colors, typography, spacing, shadows, and UI components. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| zdr | No | `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless your organization has ZDR. | |
| domain | No | Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both. | |
| maxAgeMs | No | Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1 year. `0` refreshes. | |
| directUrl | No | Exact URL to inspect. Provide either `domain` or `directUrl`, not both. | |
| colorScheme | No | Optional browser color scheme to emulate for websites that respond to prefers-color-scheme. This value is part of the styleguide cache key. |
context_dev_post_v1_brand_ai_productContext.dev — Extract ProductInspect
Detect whether a URL is a product page and extract a normalized product record. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Detect whether a URL is a product page and extract a normalized product record. |
context_dev_post_v1_brand_retrieveContext.dev — Retrieve BrandInspect
Resolve a company by domain, name, or ticker into a full brand profile. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Resolve a company by domain, name, or ticker into a full brand profile. |
context_dev_post_v1_brand_transaction_identifierContext.dev — Identify TransactionInspect
Map a noisy card or bank descriptor to the real merchant and its brand data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Map a noisy card or bank descriptor to the real merchant and its brand data. |
context_dev_post_v1_company_searchContext.dev — Company SearchInspect
Search companies using a natural-language query and country or headcount filters. Return company profiles, headquarters, employee and revenue ranges, and funding records with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search companies using a natural-language query and country or headcount filters. Return company profiles, headquarters, employee and revenue ranges, and funding records with cursor pagination. |
context_dev_post_v1_news_searchContext.dev — Search Company NewsInspect
Search live and historical company news by name, domain, ticker, or ISIN. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search live and historical company news by name, domain, ticker, or ISIN. |
context_dev_post_v1_people_enrichContext.dev — Enrich PersonInspect
Enrich a person from identity clues into one scored, normalized profile. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Enrich a person from identity clues into one scored, normalized profile. |
context_dev_post_v1_people_searchContext.dev — People SearchInspect
Search professionals by role, employer, location, skills, or experience. Return current employment, experience, education, and public profile links with cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search professionals by role, employer, location, skills, or experience. Return current employment, experience, education, and public profile links with cursor pagination. |
context_dev_post_v1_web_answersContext.dev — AnswersInspect
Research a natural-language task using web pages and company or people records, returning a structured answer with source URLs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Research a natural-language task using web pages and company or people records, returning a structured answer with source URLs. |
context_dev_post_v1_web_crawlContext.dev — Crawl WebsiteInspect
Crawl a website and return clean Markdown for every page crawled. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Crawl a website and return clean Markdown for every page crawled. |
context_dev_post_v1_web_extractContext.dev — Extract Structured DataInspect
Crawl a website and return JSON matching a caller-supplied JSON Schema. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Crawl a website and return JSON matching a caller-supplied JSON Schema. |
context_dev_post_v1_web_scrape_htmlContext.dev — Scrape HTMLInspect
Fetch the fully rendered HTML of any page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Fetch the fully rendered HTML of any page. |
context_dev_post_v1_web_scrape_imagesContext.dev — Scrape ImagesInspect
Extract every image asset from a page with metadata. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Extract every image asset from a page with metadata. |
context_dev_post_v1_web_scrape_markdownContext.dev — Scrape MarkdownInspect
Scrape any URL into clean, LLM-ready Markdown. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Scrape any URL into clean, LLM-ready Markdown. |
context_dev_post_v1_web_screenshotContext.dev — Capture ScreenshotInspect
Capture a rendered screenshot of a website. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Capture a rendered screenshot of a website. |
context_dev_post_v1_web_searchContext.dev — Web SearchInspect
Search the web and optionally scrape each result to Markdown in one call. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search the web and optionally scrape each result to Markdown in one call. |
dataforseo_post_v3_ai_optimization_ai_keyword_data_keywords_searDataForSEO — Ai Optimization / Ai Keyword Data / Keywords Search Volume / LiveInspect
This endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools. |
dataforseo_post_v3_ai_optimization_chat_gpt_llm_scraper_live_advDataForSEO — Ai Optimization / Chat Gpt / Llm Scraper / Live / AdvancedInspect
Live ChatGPT LLM Scraper endpoint provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live ChatGPT LLM Scraper endpoint provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters. |
dataforseo_post_v3_ai_optimization_chat_gpt_llm_scraper_live_htmDataForSEO — Ai Optimization / Chat Gpt / Llm Scraper / Live / HtmlInspect
Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location. |
dataforseo_post_v3_ai_optimization_gemini_llm_scraper_live_advanDataForSEO — Ai Optimization / Gemini / Llm Scraper / Live / AdvancedInspect
Live Gemini LLM Scraper endpoint provides structured results from Gemini. The results are specific to the selected location (see the List of Locations), language (see the List of Languages), and keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Gemini LLM Scraper endpoint provides structured results from Gemini. The results are specific to the selected location (see the List of Locations), language (see the List of Languages), and keyword. |
dataforseo_post_v3_ai_optimization_gemini_llm_scraper_live_htmlDataForSEO — Ai Optimization / Gemini / Llm Scraper / Live / HtmlInspect
Live Gemini LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language (see the List of Languages), and location (see the List of Locations). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Gemini LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language (see the List of Languages), and location (see the List of Locations). |
dataforseo_post_v3_ai_optimization_llm_mentions_multi_target_metDataForSEO — Ai Optimization / Llm Mentions / Multi Target Metrics / LiveInspect
Live LLM Mentions Multi-Target Metrics endpoint provides aggregated metrics grouped by custom keys for mentions of the keywords or domains specified in the target array of the request. Each item in the results array corresponds to the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Multi-Target Metrics endpoint provides aggregated metrics grouped by custom keys for mentions of the keywords or domains specified in the target array of the request. Each item in the results array corresponds to the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_search_mentionsDataForSEO — Ai Optimization / Llm Mentions / Search Mentions / LiveInspect
Live LLM Mentions Search endpoint provides mention data and related metrics from AI searches. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), as well as location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Search endpoint provides mention data and related metrics from AI searches. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), as well as location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_target_metrics_2DataForSEO — Ai Optimization / Llm Mentions / Target Metrics Lite / LiveInspect
Live LLM Mentions Target Metrics Lite endpoint is the simplified version of the Target Metrics endpoint and provides a simplified view of aggregated LLM mentions for keywords and domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Target Metrics Lite endpoint is the simplified version of the Target Metrics endpoint and provides a simplified view of aggregated LLM mentions for keywords and domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_target_metrics_lDataForSEO — Ai Optimization / Llm Mentions / Target Metrics / LiveInspect
Live LLM Mentions Target Metrics endpoint provides aggregated metrics for mentions of the keywords or domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Target Metrics endpoint provides aggregated metrics for mentions of the keywords or domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_2DataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Brands / LiveInspect
Live LLM Mentions Top Mentioned Brands endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Brands endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_3DataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Pages / LiveInspect
Live LLM Mentions Top Mentioned Pages endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Pages endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_4DataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Brand Categories Lite / LiveInspect
Live LLM Mentions Top Mentioned Brand Categories Lite endpoint is the simplified version of the Top Mentioned Brand Categories endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Brand Categories Lite endpoint is the simplified version of the Top Mentioned Brand Categories endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_5DataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Domains / LiveInspect
Live LLM Mentions Top Mentioned Domains endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Domains endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_6DataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Brand Categories / LiveInspect
Live LLM Mentions Top Mentioned Brand Categories endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Brand Categories endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_brDataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Brands Lite / LiveInspect
Live LLM Mentions Top Mentioned Brands Lite endpoint is the simplified version of the Top Mentioned Brands endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Brands Lite endpoint is the simplified version of the Top Mentioned Brands endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_doDataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Domains Lite / LiveInspect
Live LLM Mentions Top Mentioned Domains Lite endpoint is the simplified version of the Top Mentioned Domains endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Domains Lite endpoint is the simplified version of the Top Mentioned Domains endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_paDataForSEO — Ai Optimization / Llm Mentions / Top Mentioned Pages Lite / LiveInspect
Live LLM Mentions Top Mentioned Pages Lite endpoint is a simplified version of the Top Mentioned Pages that provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live LLM Mentions Top Mentioned Pages Lite endpoint is a simplified version of the Top Mentioned Pages that provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages). |
dataforseo_post_v3_app_data_apple_app_listings_search_liveDataForSEO — App Data / Apple / App Listings / Search / LiveInspect
This endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request. |
dataforseo_post_v3_app_data_google_app_listings_search_liveDataForSEO — App Data / Google / App Listings / Search / LiveInspect
This endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request. |
dataforseo_post_v3_backlinks_anchors_liveDataForSEO — Backlinks / Anchors / LiveInspect
This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them. |
dataforseo_post_v3_backlinks_backlinks_liveDataForSEO — Backlinks / Backlinks / LiveInspect
This endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage. |
dataforseo_post_v3_backlinks_bulk_backlinks_liveDataForSEO — Backlinks / Bulk Backlinks / LiveInspect
This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. |
dataforseo_post_v3_backlinks_bulk_new_lost_backlinks_liveDataForSEO — Backlinks / Bulk New Lost Backlinks / LiveInspect
This endpoint will provide you with the number of new and lost backlinks for the domains, subdomains, and pages specified in the targets array. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the number of new and lost backlinks for the domains, subdomains, and pages specified in the targets array. |
dataforseo_post_v3_backlinks_bulk_new_lost_referring_domains_livDataForSEO — Backlinks / Bulk New Lost Referring Domains / LiveInspect
This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array. |
dataforseo_post_v3_backlinks_bulk_pages_summary_liveDataForSEO — Backlinks / Bulk Pages Summary / LiveInspect
This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page. |
dataforseo_post_v3_backlinks_bulk_ranks_liveDataForSEO — Backlinks / Bulk Ranks / LiveInspect
This endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm. You can learn more about rank scores in this help center article Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm. You can learn more about rank scores in this help center article |
dataforseo_post_v3_backlinks_bulk_referring_domains_liveDataForSEO — Backlinks / Bulk Referring Domains / LiveInspect
This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. |
dataforseo_post_v3_backlinks_bulk_spam_score_liveDataForSEO — Backlinks / Bulk Spam Score / LiveInspect
This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100. You can learn more about Spam Score, how it is calculated, and signals it takes into account in this help center article Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100. You can learn more about Spam Score, how it is calculated, and signals it takes into account in this help center article |
dataforseo_post_v3_backlinks_competitors_liveDataForSEO — Backlinks / Competitors / LiveInspect
This endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website. |
dataforseo_post_v3_backlinks_domain_intersection_liveDataForSEO — Backlinks / Domain Intersection / LiveInspect
This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website. |
dataforseo_post_v3_backlinks_domain_pages_liveDataForSEO — Backlinks / Domain Pages / LiveInspect
This endpoint will provide you with a detailed overview of domain pages with backlink data for each page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a detailed overview of domain pages with backlink data for each page. |
dataforseo_post_v3_backlinks_domain_pages_summary_liveDataForSEO — Backlinks / Domain Pages Summary / LiveInspect
This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page. |
dataforseo_post_v3_backlinks_page_intersection_liveDataForSEO — Backlinks / Page Intersection / LiveInspect
This endpoint will provide you with the list of referring pages pointing to the specified targets. It is especially useful for finding the backlinks that point to your competitors but don’t point to your website. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the list of referring pages pointing to the specified targets. It is especially useful for finding the backlinks that point to your competitors but don’t point to your website. |
dataforseo_post_v3_backlinks_referring_domains_liveDataForSEO — Backlinks / Referring Domains / LiveInspect
This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify. |
dataforseo_post_v3_backlinks_referring_networks_liveDataForSEO — Backlinks / Referring Networks / LiveInspect
This endpoint will provide you with a detailed overview of referring IPs and subnets pointing to the target you specify. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a detailed overview of referring IPs and subnets pointing to the target you specify. |
dataforseo_post_v3_backlinks_summary_liveDataForSEO — Backlinks / Summary / LiveInspect
This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage. |
dataforseo_post_v3_business_data_business_listings_categories_agDataForSEO — Business Data / Business Listings / Categories Aggregation / LiveInspect
Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. The provided results are specific to the specified parameters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. The provided results are specific to the specified parameters. |
dataforseo_post_v3_business_data_business_listings_search_liveDataForSEO — Business Data / Business Listings / Search / LiveInspect
Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings. |
dataforseo_post_v3_business_data_google_hotel_info_live_advancedDataForSEO — Business Data / Google / Hotel Info / Live / AdvancedInspect
Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. |
dataforseo_post_v3_business_data_google_hotel_info_live_htmlDataForSEO — Business Data / Google / Hotel Info / Live / HtmlInspect
Google Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Google Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. |
dataforseo_post_v3_business_data_google_hotel_searches_liveDataForSEO — Business Data / Google / Hotel Searches / LiveInspect
Hotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Hotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. |
dataforseo_post_v3_business_data_google_my_business_info_liveDataForSEO — Business Data / Google / My Business Info / LiveInspect
Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. |
dataforseo_post_v3_business_data_google_questions_and_answers_liDataForSEO — Business Data / Google / Questions And Answers / LiveInspect
This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Your account will be billed for every 20 questions, Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5. |
dataforseo_post_v3_content_analysis_rating_distribution_liveDataForSEO — Content Analysis / Rating Distribution / LiveInspect
This endpoint will provide you with rating distribution data for the keyword and other parameters specified in the request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with rating distribution data for the keyword and other parameters specified in the request. |
dataforseo_post_v3_content_analysis_search_liveDataForSEO — Content Analysis / Search / LiveInspect
This endpoint will provide you with detailed citation data available for the target keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with detailed citation data available for the target keyword. |
dataforseo_post_v3_content_analysis_sentiment_analysis_liveDataForSEO — Content Analysis / Sentiment Analysis / LiveInspect
This endpoint will provide you with sentiment analysis data for the citations available for the target keyword. for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/sentiment_analysis/live/?bash' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with sentiment analysis data for the citations available for the target keyword. for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/sentiment_analysis/live/?bash' |
dataforseo_post_v3_content_analysis_summary_liveDataForSEO — Content Analysis / Summary / LiveInspect
This endpoint will provide you with an overview of citation data available for the target keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with an overview of citation data available for the target keyword. |
dataforseo_post_v3_dataforseo_labs_amazon_bulk_search_volume_livDataForSEO — Dataforseo Labs / Amazon / Bulk Search Volume / LiveInspect
This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request. |
dataforseo_post_v3_dataforseo_labs_amazon_product_competitors_liDataForSEO — Dataforseo Labs / Amazon / Product Competitors / LiveInspect
This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request. |
dataforseo_post_v3_dataforseo_labs_amazon_product_keyword_intersDataForSEO — Dataforseo Labs / Amazon / Product Keyword Intersections / LiveInspect
This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. |
dataforseo_post_v3_dataforseo_labs_amazon_product_rank_overviewDataForSEO — Dataforseo Labs / Amazon / Product Rank Overview / LiveInspect
This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. |
dataforseo_post_v3_dataforseo_labs_amazon_ranked_keywords_liveDataForSEO — Dataforseo Labs / Amazon / Ranked Keywords / LiveInspect
This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article. |
dataforseo_post_v3_dataforseo_labs_google_bulk_keyword_difficultDataForSEO — Dataforseo Labs / Google / Bulk Keyword Difficulty / LiveInspect
This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100. |
dataforseo_post_v3_dataforseo_labs_google_bulk_traffic_estimatioDataForSEO — Dataforseo Labs / Google / Bulk Traffic Estimation / LiveInspect
This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. |
dataforseo_post_v3_dataforseo_labs_google_categories_for_domainDataForSEO — Dataforseo Labs / Google / Categories For Domain / LiveInspect
This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category. |
dataforseo_post_v3_dataforseo_labs_google_categories_for_keywordDataForSEO — Dataforseo Labs / Google / Categories For Keywords / LiveInspect
This endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request. |
dataforseo_post_v3_dataforseo_labs_google_competitors_domain_livDataForSEO — Dataforseo Labs / Google / Competitors Domain / LiveInspect
This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP. |
dataforseo_post_v3_dataforseo_labs_google_domain_intersection_liDataForSEO — Dataforseo Labs / Google / Domain Intersection / LiveInspect
This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and other data on each intersecting keyword. Along with that, you will get data on the first and second domain’s SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. Domain Intersection endpoint supports organic, paid, local pack, and featured snippet results. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_intersection/live/?bash' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and other data on each intersecting keyword. Along with that, you will get data on the first and second domain’s SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. Domain Intersection endpoint supports organic, paid, local pack, and featured snippet results. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_intersection/live/?bash' |
dataforseo_post_v3_dataforseo_labs_google_domain_metrics_by_cateDataForSEO — Dataforseo Labs / Google / Domain Metrics By Categories / LiveInspect
This endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. You will receive historical ranking data from Google SERPs, along with valuable current and historical domain metrics, such as ETV, impressions ETV, estimated paid traffic cost, the total count of SERPs that contain domains, and more. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. You will receive historical ranking data from Google SERPs, along with valuable current and historical domain metrics, such as ETV, impressions ETV, estimated paid traffic cost, the total count of SERPs that contain domains, and more. |
dataforseo_post_v3_dataforseo_labs_google_domain_rank_overview_lDataForSEO — Dataforseo Labs / Google / Domain Rank Overview / LiveInspect
This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results. |
dataforseo_post_v3_dataforseo_labs_google_historical_bulk_traffiDataForSEO — Dataforseo Labs / Google / Historical Bulk Traffic Estimation / LiveInspect
This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. |
dataforseo_post_v3_dataforseo_labs_google_historical_keyword_datDataForSEO — Dataforseo Labs / Google / Historical Keyword Data / LiveInspect
This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here. |
dataforseo_post_v3_dataforseo_labs_google_historical_serps_liveDataForSEO — Dataforseo Labs / Google / Historical Serps / LiveInspect
This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location. |
dataforseo_post_v3_dataforseo_labs_google_keyword_ideas_liveDataForSEO — Dataforseo Labs / Google / Keyword Ideas / LiveInspect
The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array. |
dataforseo_post_v3_dataforseo_labs_google_keyword_overview_liveDataForSEO — Dataforseo Labs / Google / Keyword Overview / LiveInspect
This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter. |
dataforseo_post_v3_dataforseo_labs_google_keywords_for_categorieDataForSEO — Dataforseo Labs / Google / Keywords For Categories / LiveInspect
This endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword. |
dataforseo_post_v3_dataforseo_labs_google_keywords_for_site_liveDataForSEO — Dataforseo Labs / Google / Keywords For Site / LiveInspect
The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain, subdomain, or webpage. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain, subdomain, or webpage. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months. |
dataforseo_post_v3_dataforseo_labs_google_page_intersection_liveDataForSEO — Dataforseo Labs / Google / Page Intersection / LiveInspect
This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/page_intersection/live/?bash' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/page_intersection/live/?bash' |
dataforseo_post_v3_dataforseo_labs_google_ranked_keywords_liveDataForSEO — Dataforseo Labs / Google / Ranked Keywords / LiveInspect
This endpoint will provide you with the list of keywords that any domain, subdomain, or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as monthly searches and other data relevant to the returned keywords. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the list of keywords that any domain, subdomain, or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as monthly searches and other data relevant to the returned keywords. |
dataforseo_post_v3_dataforseo_labs_google_relevant_pages_liveDataForSEO — Dataforseo Labs / Google / Relevant Pages / LiveInspect
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | |
dataforseo_post_v3_dataforseo_labs_google_search_intent_liveDataForSEO — Dataforseo Labs / Google / Search Intent / LiveInspect
This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability. |
dataforseo_post_v3_dataforseo_labs_google_serp_competitors_liveDataForSEO — Dataforseo Labs / Google / Serp Competitors / LiveInspect
This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords. |
dataforseo_post_v3_dataforseo_labs_google_subdomains_liveDataForSEO — Dataforseo Labs / Google / Subdomains / LiveInspect
This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions. |
dataforseo_post_v3_dataforseo_labs_google_top_searches_liveDataForSEO — Dataforseo Labs / Google / Top Searches / LiveInspect
The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data. |
dataforseo_post_v3_domain_analytics_technologies_aggregation_tecDataForSEO — Domain Analytics / Technologies / Aggregation Technologies / LiveInspect
The Aggregation Technologies endpoint will provide you with a list of the most popular technologies websites use alongside the technologies you specify. Alternatively, you can specify technology categories or groups to obtain wider stats. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The Aggregation Technologies endpoint will provide you with a list of the most popular technologies websites use alongside the technologies you specify. Alternatively, you can specify technology categories or groups to obtain wider stats. |
dataforseo_post_v3_domain_analytics_technologies_domains_by_htmlDataForSEO — Domain Analytics / Technologies / Domains By Html Terms / LiveInspect
This endpoint provides domains based on the HTML terms they use on their homepage. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides domains based on the HTML terms they use on their homepage. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data. |
dataforseo_post_v3_domain_analytics_technologies_domains_by_techDataForSEO — Domain Analytics / Technologies / Domains By Technology / LiveInspect
This endpoint provides domains based on the technology they use. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides domains based on the technology they use. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data. |
dataforseo_post_v3_domain_analytics_technologies_domain_technoloDataForSEO — Domain Analytics / Technologies / Domain Technologies / LiveInspect
Using this endpoint you will get a list of technologies used in a particular domain. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Using this endpoint you will get a list of technologies used in a particular domain. |
dataforseo_post_v3_domain_analytics_whois_overview_liveDataForSEO — Domain Analytics / Whois / Overview / LiveInspect
This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request. |
dataforseo_post_v3_keywords_data_bing_audience_estimation_liveDataForSEO — Keywords Data / Bing / Audience Estimation / LiveInspect
This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics. |
dataforseo_post_v3_keywords_data_bing_keyword_performance_liveDataForSEO — Keywords Data / Bing / Keyword Performance / LiveInspect
You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. |
dataforseo_post_v3_keywords_data_bing_keywords_for_keywords_liveDataForSEO — Keywords Data / Bing / Keywords For Keywords / LiveInspect
This endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. |
dataforseo_post_v3_keywords_data_bing_keywords_for_site_liveDataForSEO — Keywords Data / Bing / Keywords For Site / LiveInspect
This endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition values for paid search. The maximum number of returned keywords is 3000. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition values for paid search. The maximum number of returned keywords is 3000. |
dataforseo_post_v3_keywords_data_bing_search_volume_history_liveDataForSEO — Keywords Data / Bing / Search Volume History / LiveInspect
This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type. |
dataforseo_post_v3_keywords_data_bing_search_volume_liveDataForSEO — Keywords Data / Bing / Search Volume / LiveInspect
This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search. |
dataforseo_post_v3_keywords_data_clickstream_data_bulk_search_voDataForSEO — Keywords Data / Clickstream Data / Bulk Search Volume / LiveInspect
The Bulk Clickstream Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers historical search volume values for up to 12 months (depending on keywords, location, and language parameters). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The Bulk Clickstream Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers historical search volume values for up to 12 months (depending on keywords, location, and language parameters). |
dataforseo_post_v3_keywords_data_clickstream_data_dataforseo_seaDataForSEO — Keywords Data / Clickstream Data / Dataforseo Search Volume / LiveInspect
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | |
dataforseo_post_v3_keywords_data_clickstream_data_global_searchDataForSEO — Keywords Data / Clickstream Data / Global Search Volume / LiveInspect
The Clickstream Global Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers geographical distribution of clickstream search volume values across all available locations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The Clickstream Global Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers geographical distribution of clickstream search volume values across all available locations. |
dataforseo_post_v3_keywords_data_dataforseo_trends_demography_liDataForSEO — Keywords Data / Dataforseo Trends / Demography / LiveInspect
This endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data. You can check keyword trends for Google Search, Google News, and Google Shopping. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data. You can check keyword trends for Google Search, Google News, and Google Shopping. |
dataforseo_post_v3_keywords_data_dataforseo_trends_explore_liveDataForSEO — Keywords Data / Dataforseo Trends / Explore / LiveInspect
This endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping. |
dataforseo_post_v3_keywords_data_dataforseo_trends_merged_data_lDataForSEO — Keywords Data / Dataforseo Trends / Merged Data / LiveInspect
This endpoint will provide you with the keyword popularity data from DataForSEO Trends. In addition to keyword popularity rate over the given time range, you will get location-specific keyword popularity data, and a demographic breakdown of keyword popularity per each specified term along with comparative values. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the keyword popularity data from DataForSEO Trends. In addition to keyword popularity rate over the given time range, you will get location-specific keyword popularity data, and a demographic breakdown of keyword popularity per each specified term along with comparative values. |
dataforseo_post_v3_keywords_data_dataforseo_trends_subregion_intDataForSEO — Keywords Data / Dataforseo Trends / Subregion Interests / LiveInspect
This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping. |
dataforseo_post_v3_keywords_data_google_ads_ad_traffic_by_keyworDataForSEO — Keywords Data / Google Ads / Ad Traffic By Keywords / LiveInspect
Forecast Google Ads campaign impressions, CPC and clicks for the supplied keywords and selected future period. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Forecast Google Ads campaign impressions, CPC and clicks for the supplied keywords and selected future period. |
dataforseo_post_v3_keywords_data_google_ads_keywords_for_keywordDataForSEO — Keywords Data / Google Ads / Keywords For Keywords / LiveInspect
Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. |
dataforseo_post_v3_keywords_data_google_ads_keywords_for_site_liDataForSEO — Keywords Data / Google Ads / Keywords For Site / LiveInspect
Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels. |
dataforseo_post_v3_keywords_data_google_ads_search_volume_liveDataForSEO — Keywords Data / Google Ads / Search Volume / LiveInspect
Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. |
dataforseo_post_v3_keywords_data_google_trends_explore_liveDataForSEO — Keywords Data / Google Trends / Explore / LiveInspect
This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube. |
dataforseo_post_v3_merchant_amazon_asin_live_advancedDataForSEO — Merchant / Amazon / Asin / Live / AdvancedInspect
This endpoint will provide you with a full list of ASINs assigned to different modifications of a product. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with a full list of ASINs assigned to different modifications of a product. |
dataforseo_post_v3_merchant_amazon_asin_live_htmlDataForSEO — Merchant / Amazon / Asin / Live / HtmlInspect
This endpoint will provide you with the results in the HTML format. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint will provide you with the results in the HTML format. |
dataforseo_post_v3_merchant_amazon_products_live_advancedDataForSEO — Merchant / Amazon / Products / Live / AdvancedInspect
This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters. |
dataforseo_post_v3_merchant_amazon_products_live_htmlDataForSEO — Merchant / Amazon / Products / Live / HtmlInspect
This endpoint provides results in the HTML format. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides results in the HTML format. |
dataforseo_post_v3_merchant_amazon_sellers_live_advancedDataForSEO — Merchant / Amazon / Sellers / Live / AdvancedInspect
This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. |
dataforseo_post_v3_merchant_amazon_sellers_live_htmlDataForSEO — Merchant / Amazon / Sellers / Live / HtmlInspect
This endpoint provides results in the HTML format. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint provides results in the HTML format. |
dataforseo_post_v3_on_page_content_parsing_liveDataForSEO — On Page / Content Parsing / LiveInspect
This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. |
dataforseo_post_v3_on_page_instant_pagesDataForSEO — On Page / Instant PagesInspect
Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search. for more info please visit 'https://docs.dataforseo.com/v3/on_page/instant_pages/?bash' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search. for more info please visit 'https://docs.dataforseo.com/v3/on_page/instant_pages/?bash' |
dataforseo_post_v3_on_page_lighthouse_live_jsonDataForSEO — On Page / Lighthouse / Live / JsonInspect
The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. |
dataforseo_post_v3_on_page_page_screenshotDataForSEO — On Page / Page ScreenshotInspect
Using this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Using this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it. |
dataforseo_post_v3_serp_bing_organic_live_advancedDataForSEO — Serp / Bing / Organic / Live / AdvancedInspect
Live SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs. |
dataforseo_post_v3_serp_bing_organic_live_htmlDataForSEO — Serp / Bing / Organic / Live / HtmlInspect
Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_bing_organic_live_regularDataForSEO — Serp / Bing / Organic / Live / RegularInspect
Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_ai_mode_live_advancedDataForSEO — Serp / Google / Ai Mode / Live / AdvancedInspect
Google AI Mode SERP API provides search results from the AI Mode feature of Google Search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Google AI Mode SERP API provides search results from the AI Mode feature of Google Search. |
dataforseo_post_v3_serp_google_ai_mode_live_htmlDataForSEO — Serp / Google / Ai Mode / Live / HtmlInspect
Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_autocomplete_live_advancedDataForSEO — Serp / Google / Autocomplete / Live / AdvancedInspect
Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client. |
dataforseo_post_v3_serp_google_dataset_info_live_advancedDataForSEO — Serp / Google / Dataset Info / Live / AdvancedInspect
Live Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP. |
dataforseo_post_v3_serp_google_dataset_search_live_advancedDataForSEO — Serp / Google / Dataset Search / Live / AdvancedInspect
Live Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally. |
dataforseo_post_v3_serp_google_finance_explore_live_advancedDataForSEO — Serp / Google / Finance Explore / Live / AdvancedInspect
Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. |
dataforseo_post_v3_serp_google_finance_explore_live_htmlDataForSEO — Serp / Google / Finance Explore / Live / HtmlInspect
Live SERP HTML provides raw HTML page from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides raw HTML page from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. |
dataforseo_post_v3_serp_google_finance_markets_live_advancedDataForSEO — Serp / Google / Finance Markets / Live / AdvancedInspect
Live Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type. |
dataforseo_post_v3_serp_google_finance_markets_live_htmlDataForSEO — Serp / Google / Finance Markets / Live / HtmlInspect
Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. |
dataforseo_post_v3_serp_google_finance_quote_live_advancedDataForSEO — Serp / Google / Finance Quote / Live / AdvancedInspect
Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. |
dataforseo_post_v3_serp_google_finance_quote_live_htmlDataForSEO — Serp / Google / Finance Quote / Live / HtmlInspect
Live SERP HTML provides raw HTML from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides raw HTML from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. |
dataforseo_post_v3_serp_google_finance_ticker_search_live_advancDataForSEO — Serp / Google / Finance Ticker Search / Live / AdvancedInspect
Live Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language. |
dataforseo_post_v3_serp_google_images_live_advancedDataForSEO — Serp / Google / Images / Live / AdvancedInspect
Live Google Images SERP provides real-time data on top 100 images results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Images SERP provides real-time data on top 100 images results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_images_live_htmlDataForSEO — Serp / Google / Images / Live / HtmlInspect
Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_local_finder_live_advancedDataForSEO — Serp / Google / Local Finder / Live / AdvancedInspect
Live Google Local_finder SERP provides real-time search engine results for the specified keyword and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Local_finder SERP provides real-time search engine results for the specified keyword and location. |
dataforseo_post_v3_serp_google_local_finder_live_htmlDataForSEO — Serp / Google / Local Finder / Live / HtmlInspect
Live Google Local Finder SERP HTML provides a raw HTML page of the search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Local Finder SERP HTML provides a raw HTML page of the search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_maps_live_advancedDataForSEO — Serp / Google / Maps / Live / AdvancedInspect
Live Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_news_live_advancedDataForSEO — Serp / Google / News / Live / AdvancedInspect
Live Google News SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Google News SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_news_live_htmlDataForSEO — Serp / Google / News / Live / HtmlInspect
Live SERP HTML provides a raw HTML page of 10 search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides a raw HTML page of 10 search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_organic_live_advancedDataForSEO — Serp / Google / Organic / Live / AdvancedInspect
Live SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs. for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?bash' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs. for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?bash' |
dataforseo_post_v3_serp_google_organic_live_htmlDataForSEO — Serp / Google / Organic / Live / HtmlInspect
Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_google_organic_live_regularDataForSEO — Serp / Google / Organic / Live / RegularInspect
Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_yahoo_organic_live_advancedDataForSEO — Serp / Yahoo / Organic / Live / AdvancedInspect
Live SERP provides real-time data on top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP provides real-time data on top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. |
dataforseo_post_v3_serp_yahoo_organic_live_htmlDataForSEO — Serp / Yahoo / Organic / Live / HtmlInspect
Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_yahoo_organic_live_regularDataForSEO — Serp / Yahoo / Organic / Live / RegularInspect
Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location. |
dataforseo_post_v3_serp_youtube_organic_live_advancedDataForSEO — Serp / Youtube / Organic / Live / AdvancedInspect
Live SERP provides real-time data on the top 20 blocks of YouTube search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/live/advanced/' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live SERP provides real-time data on the top 20 blocks of YouTube search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/live/advanced/' |
dataforseo_post_v3_serp_youtube_video_comments_live_advancedDataForSEO — Serp / Youtube / Video Comments / Live / AdvancedInspect
Live YouTube Comments provides real-time data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live YouTube Comments provides real-time data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics. |
dataforseo_post_v3_serp_youtube_video_info_live_advancedDataForSEO — Serp / Youtube / Video Info / Live / AdvancedInspect
Live YouTube Video Info provides real-time data on the video you specify in the request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/?bash' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live YouTube Video Info provides real-time data on the video you specify in the request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/?bash' |
dataforseo_post_v3_serp_youtube_video_subtitles_live_advancedDataForSEO — Serp / Youtube / Video Subtitles / Live / AdvancedInspect
Live YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. You will get data from the watching page containing subtitled text, its language, and duration in the video. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/?bash' Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Live YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. You will get data from the watching page containing subtitled text, its language, and duration in the video. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/?bash' |
defillama_get_batchhistoricalDefiLlama — Get historical prices for multiple tokens at multiple different timestampsInspect
Get historical prices for multiple tokens at multiple different timestamps Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| coins | Yes | object where keys are coins in the form {chain}:{address}, and values are arrays of requested timestamps |
defillama_get_block_chain_timestampDefiLlama — Get the closest block to a timestampInspect
Get the closest block to a timestamp Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain | Yes | Chain which you want to get the block from | |
| timestamp | Yes | UNIX timestamp of the block you are searching for |
defillama_get_chart_coinsDefiLlama — Get token prices at regular time intervalsInspect
Get token prices at regular time intervals Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | unix timestamp of latest data point requested | |
| span | No | number of data points returned, defaults to 0 | |
| coins | Yes | set of comma-separated tokens defined as {chain}:{address} | |
| start | No | unix timestamp of earliest data point requested | |
| period | No | duration between data points, defaults to 24 hours |
defillama_get_overview_dexsDefiLlama — List all dexs along with summaries of their volumes and dataType history dataInspect
List all dexs along with summaries of their volumes and dataType history data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_overview_dexs_chainDefiLlama — List all dexs along with summaries of their volumes and dataType history data filtering by chainInspect
List all dexs along with summaries of their volumes and dataType history data filtering by chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain | Yes | chain name, list of all supported chains can be found under allChains attribute in /overview/dexs response | |
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_overview_feesDefiLlama — List all protocols along with summaries of their fees and revenue and dataType history dataInspect
List all protocols along with summaries of their fees and revenue and dataType history data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dataType | No | Desired data type, dailyFees by default. | |
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_overview_fees_chainDefiLlama — List all protocols along with summaries of their fees and revenue and dataType history data by chainInspect
List all protocols along with summaries of their fees and revenue and dataType history data by chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain | Yes | chain name, list of all supported chains can be found under allChains attribute in /overview/fees response | |
| dataType | No | Desired data type, dailyFees by default. | |
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_overview_open_interestDefiLlama — List all open interest dex exchanges along with summaries of their open interestInspect
List all open interest dex exchanges along with summaries of their open interest Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_overview_optionsDefiLlama — List all options dexs along with summaries of their volumes and dataType history dataInspect
List all options dexs along with summaries of their volumes and dataType history data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dataType | No | Desired data type, dailyNotionalVolume by default. | |
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_overview_options_chainDefiLlama — List all options dexs along with summaries of their volumes and dataType history data filtering by chainInspect
List all options dexs along with summaries of their volumes and dataType history data filtering by chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain | Yes | chain name, list of all supported chains can be found under allChains attribute in /overview/options response | |
| dataType | No | Desired data type, dailyNotionalVolume by default. | |
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_percentage_coinsDefiLlama — Get percentage change in price over timeInspect
Get percentage change in price over time Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| coins | Yes | set of comma-separated tokens defined as {chain}:{address} | |
| period | No | duration between data points, defaults to 24 hours | |
| timestamp | No | timestamp of data point requested, defaults to time now | |
| lookForward | No | whether you want the duration after your given timestamp or not, defaults to false (looking back) |
defillama_get_prices_current_coinsDefiLlama — Get current prices of tokens by contract addressInspect
Get current prices of tokens by contract address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| coins | Yes | set of comma-separated tokens defined as {chain}:{address} |
defillama_get_prices_first_coinsDefiLlama — Get earliest timestamp price record for coinsInspect
Get earliest timestamp price record for coins Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| coins | Yes | set of comma-separated tokens defined as {chain}:{address} |
defillama_get_prices_historical_timestamp_coinsDefiLlama — Get historical prices of tokens by contract addressInspect
Get historical prices of tokens by contract address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| coins | Yes | set of comma-separated tokens defined as {chain}:{address} | |
| timestamp | Yes | UNIX timestamp of time when you want historical prices |
defillama_get_protocol_protocolDefiLlama — Get historical TVL of a protocol and breakdowns by token and chainInspect
Get historical TVL of a protocol and breakdowns by token and chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| protocol | Yes | protocol slug |
defillama_get_protocolsDefiLlama — List all protocols on defillama along with their tvlInspect
List all protocols on defillama along with their tvl Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
defillama_get_stablecoin_assetDefiLlama — Get historical mcap and historical chain distribution of a stablecoinInspect
Get historical mcap and historical chain distribution of a stablecoin Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | Yes | stablecoin ID, you can get these from /stablecoins |
defillama_get_stablecoinchainsDefiLlama — Get current mcap sum of all stablecoins on each chainInspect
Get current mcap sum of all stablecoins on each chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
defillama_get_stablecoincharts_allDefiLlama — Get historical mcap sum of all stablecoinsInspect
Get historical mcap sum of all stablecoins Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| stablecoin | No | stablecoin ID, you can get these from /stablecoins |
defillama_get_stablecoinpricesDefiLlama — Get historical prices of all stablecoinsInspect
Get historical prices of all stablecoins Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
defillama_get_stablecoinsDefiLlama — List all stablecoins along with their circulating amountsInspect
List all stablecoins along with their circulating amounts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| includePrices | No | set whether to include current stablecoin prices |
defillama_get_summary_dexs_protocolDefiLlama — Get summary of dex volume with historical dataInspect
Get summary of dex volume with historical data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| protocol | Yes | protocol slug | |
| excludeTotalDataChart | Yes | true to exclude aggregated chart from response | |
| excludeTotalDataChartBreakdown | Yes | true to exclude broken down chart from response |
defillama_get_summary_fees_protocolDefiLlama — Get summary of protocol fees and revenue with historical dataInspect
Get summary of protocol fees and revenue with historical data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dataType | No | Desired data type, dailyFees by default. | |
| protocol | Yes | protocol slug |
defillama_get_summary_options_protocolDefiLlama — Get summary of options dex volume with historical dataInspect
Get summary of options dex volume with historical data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dataType | No | Desired data type, dailyNotionalVolume by default. | |
| protocol | Yes | protocol slug |
defillama_get_tvl_protocolDefiLlama — Simplified endpoint to get current TVL of a protocolInspect
Simplified endpoint to get current TVL of a protocol Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| protocol | Yes | protocol slug |
defillama_get_v2_chainsDefiLlama — Get current TVL of all chainsInspect
Get current TVL of all chains Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
defillama_get_v2_historicalchaintvlDefiLlama — Get historical TVL (excludes liquid staking and double counted tvl) of DeFi on all chainsInspect
Get historical TVL (excludes liquid staking and double counted tvl) of DeFi on all chains Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
defillama_get_v2_historicalchaintvl_chainDefiLlama — Get historical TVL (excludes liquid staking and double counted tvl) of a chainInspect
Get historical TVL (excludes liquid staking and double counted tvl) of a chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain | Yes | chain slug, you can get these from /chains or the chains property on /protocols |
dexscreener_get_ads_latest_v1DEX Screener — Get the latest adsInspect
Get the latest ads. Uses the native DEX Screener public GET endpoint. Returns promotion metadata only and does not purchase advertising or boosts. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
dexscreener_get_community_takeovers_latest_v1DEX Screener — Get the latest token community takeoversInspect
Get the latest token community takeovers. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
dexscreener_get_latest_dex_pairs_chainid_pairidDEX Screener — Get one or multiple pairs by chain and pair addressInspect
Get one or multiple pairs by chain and pair address. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pairId | Yes | DEX pair or liquidity-pool address on the selected chain. Obtain pairAddress from search or token-pairs results; a token mint address is not a pair address. | |
| chainId | Yes | DEX Screener chain slug, such as solana or ethereum. Use the chainId returned by a pair or token-profile response; do not pass a numeric EVM chain ID. |
dexscreener_get_latest_dex_searchDEX Screener — Search for pairs matching queryInspect
Search for pairs matching query. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Search text, such as a token symbol, token address, or pair name like SOL/USDC. Results can span chains; use each returned pair chainId in follow-up requests. |
dexscreener_get_metas_meta_v1_slugDEX Screener — Get meta information for a given slugInspect
Get meta information for a given slug. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Exact meta slug returned by GET /metas/trending/v1. A meta is a token theme or category, not a token contract address. |
dexscreener_get_metas_trending_v1DEX Screener — Get trending metasInspect
Get trending metas. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
dexscreener_get_orders_v1_chainid_tokenaddressDEX Screener — Check paid orders for a tokenInspect
Check paid orders for a token. Uses the native DEX Screener public GET endpoint. Reads existing paid promotion orders and boosts; it does not purchase, submit, or create an order. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | Yes | DEX Screener chain slug, such as solana or ethereum. Use the chainId returned by a pair or token-profile response; do not pass a numeric EVM chain ID. | |
| tokenAddress | Yes | Token contract or mint address on the selected chain. Use the token address, not a liquidity-pool address. |
dexscreener_get_token_boosts_latest_v1DEX Screener — Get the latest boosted tokensInspect
Get the latest boosted tokens. Uses the native DEX Screener public GET endpoint. Returns promotion metadata only and does not purchase advertising or boosts. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
dexscreener_get_token_boosts_top_v1DEX Screener — Get the tokens with most active boostsInspect
Get the tokens with most active boosts. Uses the native DEX Screener public GET endpoint. Returns promotion metadata only and does not purchase advertising or boosts. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
dexscreener_get_token_pairs_v1_chainid_tokenaddressDEX Screener — Get the pools of a given token addressInspect
Get the pools of a given token address. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | Yes | DEX Screener chain slug, such as solana or ethereum. Use the chainId returned by a pair or token-profile response; do not pass a numeric EVM chain ID. | |
| tokenAddress | Yes | Token contract or mint address on the selected chain. Use the token address, not a liquidity-pool address. |
dexscreener_get_token_profiles_latest_v1DEX Screener — Get the latest token profilesInspect
Get the latest token profiles. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
dexscreener_get_token_profiles_recent_updates_v1DEX Screener — Get recently updated token profilesInspect
Get recently updated token profiles. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
dexscreener_get_tokens_v1_chainid_tokenaddressesDEX Screener — Get one or multiple pairs by token addressInspect
Get one or multiple pairs by token address. Uses the native DEX Screener public GET endpoint. Anonymous native HTTP 200 captured; OpenAny gateway has not been executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | Yes | DEX Screener chain slug, such as solana or ethereum. Use the chainId returned by a pair or token-profile response; do not pass a numeric EVM chain ID. | |
| tokenAddresses | Yes | Plain comma-separated token addresses on one chain, up to 30 addresses. Pass a CSV string rather than a JSON array. The response is a list of pairs, not one result per requested token. |
financialdatasets_get_activist_ownershipFinancial Datasets — Get activist stakesInspect
Get activist stakes (SEC Schedule 13D: holders of more than 5% of a class of shares with intent to influence control), one row per reporting person. Query by ticker (who holds activist stakes in this company) or by filer_cik (what stakes does this activist hold); provide exactly one of the two. By default each stake's current state is returned; set history=true for the full amendment chain. This endpoint is the activist-only view of /beneficial-ownership. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The total number of rows to return (default: 10; no maximum). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | No | The ticker symbol of the subject company. Provide ticker or filer_cik, not both. | |
| history | No | When true, returns the full amendment history of each stake instead of only its current state. | |
| filer_cik | No | The SEC CIK of the filer (the beneficial owner). Provide ticker or filer_cik, not both. Use the /activist-ownership/filers endpoint to look up CIKs by owner name. | |
| filing_date | No | Filter by exact filing date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by filing date greater than this date (YYYY-MM-DD). | |
| filing_date_lt | No | Filter by filing date less than this date (YYYY-MM-DD). | |
| filing_date_gte | No | Filter by filing date greater than or equal to this date (YYYY-MM-DD). | |
| filing_date_lte | No | Filter by filing date less than or equal to this date (YYYY-MM-DD). |
financialdatasets_get_beneficial_ownershipFinancial Datasets — Get beneficial ownershipInspect
Get beneficial-ownership stakes (SEC Schedules 13D and 13G: holders of more than 5% of a class of shares), one row per reporting person. Query by ticker (who owns this company) or by filer_cik (what stakes does this filer hold); provide exactly one of the two. By default each stake's current state is returned; set history=true for the full amendment chain. Use type=activist for 13D stakes (intent to influence control) or type=passive for 13G stakes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Filter by stake type: activist (Schedule 13D) or passive (Schedule 13G). | |
| limit | No | The total number of rows to return (default: 10; no maximum). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | No | The ticker symbol of the subject company. Provide ticker or filer_cik, not both. | |
| history | No | When true, returns the full amendment history of each stake instead of only its current state. | |
| filer_cik | No | The SEC CIK of the filer (the beneficial owner). Provide ticker or filer_cik, not both. Use the /beneficial-ownership/filers endpoint to look up CIKs by owner name. | |
| filing_date | No | Filter by exact filing date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by filing date greater than this date (YYYY-MM-DD). | |
| filing_date_lt | No | Filter by filing date less than this date (YYYY-MM-DD). | |
| filing_date_gte | No | Filter by filing date greater than or equal to this date (YYYY-MM-DD). | |
| filing_date_lte | No | Filter by filing date less than or equal to this date (YYYY-MM-DD). |
financialdatasets_get_company_factsFinancial Datasets — Get company factsInspect
Get company facts for a ticker. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The CIK of the company. | |
| ticker | No | The ticker symbol. |
financialdatasets_get_earningsFinancial Datasets — Get earnings snapshotInspect
Get the most recent earnings snapshot for a ticker. Optional change fields are returned only when available. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of most-recent **report periods** worth of filings to return, sorted by `(report_period DESC, filing_date ASC)`. The number of entries returned may exceed `limit` when a recent period has both an 8-K and a 10-Q / 10-K. Values above 40 are clamped to 40. Non-positive or non-integer values return 400. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | Yes | The ticker symbol (e.g. `AAPL`). |
financialdatasets_get_filingsFinancial Datasets — Get SEC filingsInspect
Get SEC filings for a company. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| limit | No | The maximum number of filings to return (default: 10). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | No | The ticker symbol. | |
| filing_type | No | Filter by one or more filing types. Repeat the query parameter to pass multiple values (e.g. filing_type=10-Q&filing_type=10-K). Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. |
financialdatasets_get_financial_metricsFinancial Datasets — Get financial metricsInspect
Get financial metrics for a ticker, including valuation, profitability, efficiency, liquidity, leverage, growth, and per share metrics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. Can be used instead of ticker. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of results to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. Any ticker of the company, including a second share class, returns the company's metrics. Price-based values (market cap, enterprise value, valuation ratios, dividend yield) are not yet available for UK tickers. | |
| period | Yes | The time period for the financial data. | |
| ticker | No | The ticker symbol of the company. Required if cik is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| filing_date | No | Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lt | No | Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_gte | No | Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lte | No | Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financial_metrics_snapshotFinancial Datasets — Financial Metrics Snapshot (Real-Time)Inspect
Get the real-time financial metrics snapshot for a stock, including valuation ratios, profitability, efficiency, liquidity, leverage, growth, and per share metrics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. Can be used instead of ticker. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. Any ticker of the company, including a second share class, returns the company's metrics. Price-based values (market cap, enterprise value, valuation ratios, dividend yield) are not yet available for UK tickers. | |
| ticker | No | The ticker symbol of the company. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. |
financialdatasets_get_financialsFinancial Datasets — Get all financial statementsInspect
Get all financial statements for a ticker. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of financial statements to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. Any ticker of the company, including a second share class, returns the company's statements. | |
| period | Yes | The time period of the financial statements. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| filing_date | No | Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lt | No | Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_gte | No | Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lte | No | Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_as_reportedFinancial Datasets — Get all as-reported financialsInspect
Get the as-filed hierarchies for income statement, balance sheet, and cash flow statement in a single API call. Each period contains three nested objects; any one may be null if data is missing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. For a UK company the statement comes back as the company printed it in its annual report, in its own order and wording. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_balance_sheetsFinancial Datasets — Get balance sheetsInspect
Get balance sheets for a ticker. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of balance sheets to return This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. Any ticker of the company, including a second share class, returns the company's statements. | |
| period | Yes | The time period of the balance sheets. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| filing_date | No | Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lt | No | Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_gte | No | Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lte | No | Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_balance_sheets_as_reportedFinancial Datasets — Get balance sheet (as-reported)Inspect
Get the as-filed balance sheet hierarchy. Each line item is returned exactly as it appears on the face of the 10-K or 10-Q, with parent-child relationships preserved in the children field.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. For a UK company the statement comes back as the company printed it in its annual report, in its own order and wording. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_balance_sheets_segmentsFinancial Datasets — Get balance sheet segmentsInspect
Get balance sheet segment breakdowns (assets, goodwill, long-lived assets) by business segment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik is not provided. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_cash_flow_statementsFinancial Datasets — Get cash flow statementsInspect
Get cash flow statements for a ticker. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of cash flow statements to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. Any ticker of the company, including a second share class, returns the company's statements. | |
| period | Yes | The time period of the cash flow statements. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| filing_date | No | Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lt | No | Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_gte | No | Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lte | No | Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_cash_flow_statements_as_reporteFinancial Datasets — Get cash flow statement (as-reported)Inspect
Get the as-filed cash flow statement hierarchy. Each line item is returned exactly as it appears on the face of the 10-K or 10-Q, with parent-child relationships preserved in the children field.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. For a UK company the statement comes back as the company printed it in its annual report, in its own order and wording. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_cash_flow_statements_segmentsFinancial Datasets — Get cash flow statement segmentsInspect
Get cash flow statement segment breakdowns (capital expenditure) by business segment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik is not provided. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_income_statementsFinancial Datasets — Get income statementsInspect
Get income statements for a ticker. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of income statements to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. Any ticker of the company, including a second share class, returns the company's statements. | |
| period | Yes | The time period of the income statements. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| filing_date | No | Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lt | No | Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_gte | No | Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lte | No | Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_income_statements_as_reportedFinancial Datasets — Get income statement (as-reported)Inspect
Get the as-filed income statement hierarchy. Each line item is returned exactly as it appears on the face of the 10-K or 10-Q, with parent-child relationships preserved in the children field.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| isin | No | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `market`. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| market | No | The market the company is listed in: `US` (the default) or `UK`. For a UK company the statement comes back as the company printed it in its annual report, in its own order and wording. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik or isin is not provided. | |
| exchange | No | Deprecated alias of `market`: `LSE` means `market=UK`. Existing requests keep working. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_income_statements_segmentsFinancial Datasets — Get income statement segmentsInspect
Get income statement segment breakdowns (revenue, operating income, depreciation) by product and business segment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik is not provided. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_financials_segmentsFinancial Datasets — Get all segmented financialsInspect
Get segment breakdowns from all three financial statement types (income statement, balance sheet, cash flow) in a single API call. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The Central Index Key (CIK) of the company. | |
| limit | No | The maximum number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| period | Yes | The time period of the data. | |
| ticker | No | The ticker symbol. Required if cik is not provided. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_index_fundsFinancial Datasets — Get ETF / index-fund holdingsInspect
Query fund holdings in two directions. Provide exactly one of ticker or holding. ?ticker=SPY returns a fund's constituents and each position's weight (the fund's latest filing by default, or the composition in effect on/before as_of). ?holding=AAPL returns the funds whose latest filing holds that security, sorted by weight.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | No | Only valid with `ticker`. Returns the fund composition in effect on or before this date (YYYY-MM-DD). Without it, the fund's latest filing is returned. | |
| limit | No | The total number of rows to return (default: 50; no maximum). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| offset | No | The number of rows to skip, for pagination (default: 0). | |
| ticker | No | The fund's ticker symbol (e.g., `SPY`). Returns that fund's holdings. Mutually exclusive with `holding`. | |
| holding | No | A held security's ticker symbol (e.g., `AAPL`). Returns the funds whose latest filing holds it. Mutually exclusive with `ticker`. | |
| asset_class | No | Only valid with `ticker`. Filter constituents by instrument type: `equity` or `bond`. Omit for all holdings. |
financialdatasets_get_insider_ownershipFinancial Datasets — Get insider ownershipInspect
Get insider ownership statements from SEC Forms 3 and 5, one row per reported holding. Positions are returned as reported per filing (point-in-time ownership statements), newest filings first. A Form 3 is an insider's initial statement of what they own; a Form 5 is the annual statement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter by insider name (case-insensitive contains). Use the /insider-ownership/names endpoint to get available names for a ticker. | |
| limit | No | The total number of rows to return (default: 10; no maximum). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | Yes | The ticker symbol of the company. | |
| form_type | No | Filter by SEC form type: 3 for initial ownership statements, 5 for annual statements (or their amendments 3/A, 5/A). | |
| filing_date | No | Filter by exact filing date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by filing date greater than this date (YYYY-MM-DD). | |
| filing_date_lt | No | Filter by filing date less than this date (YYYY-MM-DD). | |
| filing_date_gte | No | Filter by filing date greater than or equal to this date (YYYY-MM-DD). | |
| filing_date_lte | No | Filter by filing date less than or equal to this date (YYYY-MM-DD). |
financialdatasets_get_insider_tradesFinancial Datasets — Get insider tradesInspect
Get insider trades like buys and sells for a ticker by a company insider. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter by insider name (e.g., 'Jen Hsun Huang'). Use the /insider-trades/names endpoint to get available names for a ticker. | |
| limit | No | The maximum number of transactions to return (default: 10). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | Yes | The ticker symbol of the company. | |
| form_type | No | Filter by SEC form type: 4 for trades, 5 for annual statements (or their amendments 4/A, 5/A). | |
| filing_date | No | Filter by exact filing date in YYYY-MM-DD format. | |
| filing_date_gt | No | Filter by filing date greater than this date (YYYY-MM-DD). | |
| filing_date_lt | No | Filter by filing date less than this date (YYYY-MM-DD). | |
| filing_date_gte | No | Filter by filing date greater than or equal to this date (YYYY-MM-DD). | |
| filing_date_lte | No | Filter by filing date less than or equal to this date (YYYY-MM-DD). | |
| transaction_type | No | Filter by transaction type (e.g., 'Open market sale', 'Gift'). Use the /insider-trades/transaction-types endpoint to get available types. |
financialdatasets_get_institutional_holdingsFinancial Datasets — Get 13F institutional holdingsInspect
Query 13F institutional holdings by filer CIK or by held ticker. Provide exactly one of filer_cik or ticker. When no report_period filter is supplied, ?filer_cik=... returns the filer's most recent 13F and ?ticker=... returns one position per institutional filer whose most recent 13F currently includes the ticker (filers who have since dropped the position are excluded).
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The total number of rows to return (default: 10; no maximum). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | No | The held security's ticker symbol. Mutually exclusive with `filer_cik`. Without a `report_period` filter, returns one position per institutional filer whose most recent 13F currently includes this ticker. | |
| filer_cik | No | The 10-digit zero-padded SEC CIK of the institutional filer. Mutually exclusive with `ticker`. | |
| report_period | No | Filter by exact report period date in YYYY-MM-DD format. | |
| report_period_gt | No | Filter by report period greater than date in YYYY-MM-DD format. | |
| report_period_lt | No | Filter by report period less than date in YYYY-MM-DD format. | |
| report_period_gte | No | Filter by report period greater than or equal to date in YYYY-MM-DD format. | |
| report_period_lte | No | Filter by report period less than or equal to date in YYYY-MM-DD format. |
financialdatasets_get_iposFinancial Datasets — Get IPO filingsInspect
Get SEC IPO filings (registration statements S-1, S-1/A, F-1, F-1/A and final prospectuses 424B4, 424B1), newest filings first. Every filing is classified (ipo, shell_company, spac, resale, or other) with structured cover-page metadata: proposed ticker, exchange, and expected offering price or price range. For IPO-grade filings whose financial statements have been extracted, the item embeds full income statements, balance sheets, and cash flow statements under financials, in the same shape as the /financials endpoints. No parameters are required: by default the latest filings across all compan Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Filter by the SEC Central Index Key of the filer, with or without leading zeros. | |
| limit | No | The total number of rows to return (default: 10; no maximum). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | No | Filter by the proposed ticker symbol from the filing's cover page. | |
| filing_date | No | Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| classification | No | Filter by filing classification: ipo (a real operating company registering to list on an exchange), shell_company, spac, resale, or other. | |
| filing_date_gt | No | Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lt | No | Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_gte | No | Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded. | |
| filing_date_lte | No | Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded. |
financialdatasets_get_kpi_guidanceFinancial Datasets — Get forward guidanceInspect
Get structured forward guidance from earnings releases. Returns ranges, point estimates, and directional signals. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| period | No | Filter by period type: quarterly or annual. | |
| ticker | Yes | The ticker symbol. | |
| metric_name | No | Filter to a specific metric. | |
| report_period_gte | No | Only return guidance on or after this date (YYYY-MM-DD). | |
| report_period_lte | No | Only return guidance on or before this date (YYYY-MM-DD). |
financialdatasets_get_kpi_metricsFinancial Datasets — Get KPI metricsInspect
Get sector-specific operational KPIs for a ticker. Includes metrics like load factor, CET1 ratio, same-store sales, FFO per share, and more. Sourced from SEC 8-K earnings releases. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of periods to return. Returns all metrics for the N most recent periods. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| period | No | Filter by period type: quarterly or annual. | |
| ticker | Yes | The ticker symbol. | |
| metric_name | No | Filter to a specific metric (e.g., load_factor, cet1_ratio). | |
| report_period_gte | No | Only return metrics on or after this date (YYYY-MM-DD). | |
| report_period_lte | No | Only return metrics on or before this date (YYYY-MM-DD). |
financialdatasets_get_kpi_non_gaapFinancial Datasets — Get non-GAAP metricsInspect
Get non-GAAP financial metrics with GAAP equivalents and key adjustments. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| period | No | Filter by period type: quarterly or annual. | |
| ticker | Yes | The ticker symbol. | |
| metric_name | No | Filter to a specific metric. | |
| report_period_gte | No | Only return metrics on or after this date (YYYY-MM-DD). | |
| report_period_lte | No | Only return metrics on or before this date (YYYY-MM-DD). |
financialdatasets_get_macro_gpu_pricesFinancial Datasets — GPU Prices (Historical)Inspect
Daily GPU rental price index history for one GPU model, newest first, in US dollars per GPU hour, with the spread across providers and the 1, 7, and 30 day changes. Dates are UTC days; each day's value is the newest print of that day, and today's value is refreshed hourly (as_of says when). Source: the Computable GPU Index; every response carries an attribution string to keep when displaying the data. A change is null when the comparison day has no value. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| series | Yes | The GPU model: h100, h200, b200, or b300. Use the /macro/gpu-prices/series endpoint to get the list. | |
| end_date | No | The last day to return, inclusive, in YYYY-MM-DD format. Defaults to today. | |
| start_date | No | The first day to return, inclusive, in YYYY-MM-DD format. Defaults to 90 days before end_date when both dates are omitted; omit it with an end_date to get all available history through that day. |
financialdatasets_get_macro_gpu_prices_snapshotFinancial Datasets — GPU Prices (Snapshot)Inspect
Today's rental price of every GPU model (four rows), or of one model when series is given, each with the spread across providers and the 1, 7, and 30 day percent changes. Refreshed hourly. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| series | No | Optional GPU model to return one row instead of all four: h100, h200, b200, or b300. |
financialdatasets_get_macro_inflationFinancial Datasets — Inflation (Historical)Inspect
Monthly US inflation history for one series (consumer price index or PCE price index), newest first, with the month-over-month and year-over-year percent changes. Dates are reference months (first day of the month). Values are index levels (1982-84 = 100 for CPI, 2017 = 100 for PCE), sourced from authoritative government sources. A change is null when the comparison month was not published. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| series | Yes | The series id, e.g. cpi_all_sa or pce_core_sa. CPI: six concepts (all items, core, food, energy, shelter, services less energy), each seasonally adjusted (_sa) and not (_nsa). PCE: pce_all_sa and pce_core_sa. Use the /macro/inflation/series endpoint to get the list. | |
| end_date | No | The last month to return, inclusive, in YYYY-MM-DD format. Defaults to today. | |
| start_date | No | The first month to return, inclusive, in YYYY-MM-DD format; any day inside a month selects that month. Defaults to five years before end_date when both dates are omitted; omit it with an end_date to get all available history through that month. |
financialdatasets_get_macro_inflation_snapshotFinancial Datasets — Inflation (Snapshot)Inspect
The most recent month of every inflation series (fourteen rows: twelve CPI, two PCE), or of one series when series is given, each with the month-over-month and year-over-year percent changes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| series | No | Optional series id to return one row instead of all fourteen, e.g. cpi_core_sa or pce_core_sa. |
financialdatasets_get_macro_interest_ratesFinancial Datasets — Interest Rates (Historical)Inspect
The daily policy rate of one central bank: one row per calendar day, newest first, 10 rows per page. A rate change appears on the first day the new rate is in effect. For the Federal Reserve the rate is the midpoint of the target range. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bank | Yes | The central bank code, e.g. FED, ECB, BOJ. Use the /macro/interest-rates/banks endpoint to get the list of available banks. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| end_date | No | The last date to return, inclusive, in YYYY-MM-DD format. Defaults to today. | |
| start_date | No | The first date to return, inclusive, in YYYY-MM-DD format. Defaults to five years before end_date when both dates are omitted; omit it with an end_date to get all available history through that date. |
financialdatasets_get_macro_interest_rates_snapshotFinancial Datasets — Interest Rates (Snapshot)Inspect
The newest published policy rate of every central bank we cover, one row per bank with the date it is in effect. Pass bank to get one bank only. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bank | No | Optional central bank code (e.g., FED, ECB, BOJ) to return one bank only. Use the /macro/interest-rates/banks endpoint to get a list of available banks. |
financialdatasets_get_macro_laborFinancial Datasets — Labor Market (Historical)Inspect
US labor market history for one series (the jobs report: nonfarm payrolls, unemployment rate, participation, hourly earnings; JOLTS job openings, hires, quits; weekly jobless claims), newest first, with the change from the prior period and from a year earlier. Dates are reference periods: the first day of the month for monthly series, the week-ending Saturday for weekly series. Values are in the series' units, sourced from authoritative government sources. A change is null when the comparison period was not published; change_year_pct is null for series measured in percent. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| series | Yes | The series id, e.g. payrolls_sa. Eight monthly concepts (payrolls, unemployment_rate, unemployment_rate_u6, participation_rate, hourly_earnings, job_openings, hires, quits) and five weekly ones (initial_claims, initial_claims_4_week, continued_claims, continued_claims_4_week, insured_unemployment_rate), each seasonally adjusted (_sa) and, except the 4-week averages, not (_nsa). Use the /macro/labor/series endpoint to get the list. | |
| end_date | No | The last period to return, inclusive, in YYYY-MM-DD format. Defaults to today. | |
| start_date | No | The first period to return, inclusive, in YYYY-MM-DD format; for a monthly series any day inside a month selects that month. Defaults to five years before end_date when both dates are omitted; omit it with an end_date to get all available history through that date. |
financialdatasets_get_macro_labor_snapshotFinancial Datasets — Labor Market (Snapshot)Inspect
The most recent print of every labor market series (24 rows: monthly series on their latest month, weekly series on their latest week), or of one series when series is given, each with the change from the prior period and from a year earlier. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| series | No | Optional series id to return one row instead of all 24, e.g. unemployment_rate_sa. |
financialdatasets_get_macro_yield_curveFinancial Datasets — Treasury Yields (Historical)Inspect
The daily US Treasury par yield curve, one object per business day with one key per tenor, newest first. Values are par yields in percent, sourced from authoritative government sources. A tenor is null when it was not published on that date. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| end_date | No | The last date to return, inclusive, in YYYY-MM-DD format. Defaults to today. | |
| start_date | No | The first date to return, inclusive, in YYYY-MM-DD format. Defaults to one year before end_date when both dates are omitted; omit it with an end_date to get all available history through that date. |
financialdatasets_get_macro_yield_curve_snapshotFinancial Datasets — Treasury Yields (Snapshot)Inspect
The most recent business day's US Treasury par yield curve as one object with one key per tenor. Refreshed each evening after the day's final curve is published. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
financialdatasets_get_newsFinancial Datasets — Get news articlesInspect
Get recent news articles for a specific company or the broad market. Pass a ticker for company-specific news, or omit the ticker for general market news. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of news articles to return (default: 5, max: 10). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`. | |
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | No | The ticker symbol of the company. Omit for broad market news. |
financialdatasets_get_pricesFinancial Datasets — Get historical stock price dataInspect
Get end-of-day (EOD) historical price data for stocks. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it. | |
| ticker | Yes | The stock ticker symbol (e.g. AAPL, MSFT). | |
| end_date | Yes | The end date for the price data (format: YYYY-MM-DD). | |
| interval | Yes | The time interval for the price data. | |
| start_date | Yes | The start date for the price data (format: YYYY-MM-DD). |
financialdatasets_get_prices_snapshotFinancial Datasets — Price Snapshot (Real-Time)Inspect
Get the real-time price snapshot for a stock, including the current price, day change, and day change percent. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ticker | Yes | The stock ticker symbol (e.g. AAPL, MSFT). |
financialdatasets_post_financials_search_line_itemsFinancial Datasets — Search specific financial metricsInspect
Search for specific financial metrics across income statements, balance sheets, and cash flow statements for a list of tickers. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search for specific financial metrics across income statements, balance sheets, and cash flow statements for a list of tickers. |
financialdatasets_post_financials_search_screenerFinancial Datasets — Search financial statementsInspect
Search for stocks by filtering across financial metrics from income statements, balance sheets, and cash flow statements. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search for stocks by filtering across financial metrics from income statements, balance sheets, and cash flow statements. |
fred_get_fred_categoryFRED — Get CategoryInspect
FRED — Get Category Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| category_id | No | The id for a category. integer, default: 0 (root category) |
fred_get_fred_category_childrenFRED — Get Child CategoriesInspect
FRED — Get Child Categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| category_id | No | The id for a category. integer, default: 0 (root category) | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_category_seriesFRED — Get Series in CategoryInspect
FRED — Get Series in Category Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity'. optional, default: series_id | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names that series match all of. String, optional, no filtering by tags by default Example value: 'income;bea'. Filter results to series having both tags 'income' and 'bea'. See the related request fred/tags. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| category_id | Yes | The id for a category. integer, required | |
| filter_value | No | The value of the filter_variable attribute to filter results by. String, optional, no filter by default | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| filter_variable | No | The attribute to filter results by. On of the following strings: 'frequency', 'units', 'seasonal_adjustment'. optional, no filter by default | |
| exclude_tag_names | No | A semicolon delimited list of tag names that series match none of. String, optional, no filtering by tags by default. Example value: 'discontinued;annual'. Filter results to series having neither tag 'discontinued' nor tag 'annual'. Parameter exclude_tag_names requires that parameter tag_names also be set to limit the number of matching series. |
fred_get_fred_category_tagsFRED — Get Category TagsInspect
Get the FRED tags for a category. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default: series_count | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names to only include in the response. See the related request fred/category/related_tags. String, optional, no filtering by tag names by default Example value: 'trade;goods'. This value filters results to only include tags 'trade' and 'goods'. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| category_id | Yes | The id for a category. integer, required | |
| search_text | No | The words to find matching tags with. String, optional, no filtering by search words by default. | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| tag_group_id | No | A tag group id to filter tags by type. String, optional, no filtering by tag group by default. One of the following: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src'. freq = Frequency gen = General or Concept geo = Geography geot = Geography Type rls = Release seas = Seasonal Adjustment src = Source | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_releaseFRED — Get ReleaseInspect
FRED — Get Release Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| release_id | Yes | The id for a release. integer, required | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_release_datesFRED — Get Dates for ReleaseInspect
Get release dates for a release of economic data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 10000, optional, default: 10000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| release_id | Yes | The id for a release. integer, required | |
| sort_order | No | Sort results is ascending or descending release date order. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available) | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: 1776-07-04 (earliest available) | |
| include_release_dates_with_no_data | No | Determines whether release dates with no data available are returned. The defalut value 'false' excludes release dates that do not have data. In particular, this excludes future release dates which may be available in the FRED release calendar or the ALFRED release calendar. One of the following strings: 'true', 'false'. optional, default: false |
fred_get_fred_releasesFRED — List Economic ReleasesInspect
FRED — List Economic Releases Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'release_id', 'name', 'press_release', 'realtime_start', 'realtime_end'. optional, default: release_id | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_releases_datesFRED — List Release DatesInspect
Get release dates for all releases of economic data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'release_date', 'release_id', 'release_name'. optional, default: release_date | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| sort_order | No | Sort results is ascending or descending release date order. One of the following strings: 'asc', 'desc'. optional, default: desc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available) | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: First day of the current year | |
| include_release_dates_with_no_data | No | Determines whether release dates with no data available are returned. The defalut value 'false' excludes release dates that do not have data. In particular, this excludes future release dates which may be available in the FRED release calendar or the ALFRED release calendar. If include_release_dates_with_no_data is set to true, the XML tag release_date has an extra attribute release_last_updated that can be compared to the release date to determine if data has been updated. One of the following strings: 'true', 'false'. optional, default: false |
fred_get_fred_release_seriesFRED — Get Series in ReleaseInspect
FRED — Get Series in Release Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity','group_popularity'. optional, default: series_id | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names that series match all of. String, optional, no filtering by tags by default Example value: 'japan;imports'. Filter results to series having both tags 'japan' and 'imports'. See the related request fred/tags. | |
| release_id | Yes | The id for a release. integer, required | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| filter_value | No | The value of the filter_variable attribute to filter results by. String, optional, no filter by default | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| filter_variable | No | The attribute to filter results by. One of the following strings: 'frequency', 'units', 'seasonal_adjustment'. optional, no filter by default | |
| exclude_tag_names | No | A semicolon delimited list of tag names that series match none of. String, optional, no filtering by tags by default. Example value: 'imports;services'. Filter results to series having neither tag 'imports' nor tag 'services'. Parameter exclude_tag_names requires that parameter tag_names also be set to limit the number of matching series. |
fred_get_fred_release_sourcesFRED — Get Release SourcesInspect
FRED — Get Release Sources Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| release_id | Yes | The id for a release. integer, required | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_release_tablesFRED — Get Release TableInspect
Get release table trees for a given release. You can go directly to the tree structure by passing the appropriate Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| element_id | No | The release table element id you would like to retrieve. integer, optional When the parameter is not passed, the root(top most) element for the release is given. | |
| release_id | Yes | The id for a release. integer, required | |
| observation_date | No | The observation date to be included with the returned release table. YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available) | |
| include_observation_values | No | A flag to indicate that observations need to be returned. Observation value and date will only be returned for a series type element. One of the following strings: 'true', 'false'. optional, default: false |
fred_get_fred_release_tagsFRED — Get Release TagsInspect
Get the FRED tags for a release. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default: series_count | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names to only include in the response. See the related request fred/release/related_tags. String, optional, no filtering by tag names by default Example value: 'gnp;quarterly'. This value filters results to only include tags 'gnp' and 'quarterly'. | |
| release_id | Yes | The id for a release. integer, required | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| search_text | No | The words to find matching tags with. String, optional, no filtering by search words by default. | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| tag_group_id | No | A tag group id to filter tags by type. String, optional, no filtering by tag group by default. One of the following: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src'. freq = Frequency gen = General or Concept geo = Geography geot = Geography Type rls = Release seas = Seasonal Adjustment src = Source | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_seriesFRED — Get Series MetadataInspect
FRED — Get Series Metadata Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| series_id | Yes | The id for a series. string, required | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_series_categoriesFRED — Get Series CategoriesInspect
FRED — Get Series Categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| series_id | Yes | The id for a series. string, required | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_series_observationsFRED — Get Series ObservationsInspect
FRED — Get Series Observations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 100000, optional, default: 100000 | |
| units | No | A key that indicates a data value transformation. string, optional, default: lin (No transformation) One of the following values: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log' lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log For unit transformation formulas, see: https://alfred.stlouisfed.org/help#growth_formulas | |
| offset | No | non-negative integer, optional, default: 0 | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json', 'xlsx', 'csv' xml = Extensible Markup Language json = JavaScript Object Notation xlsx = Excel Spreadsheet csv = Comma-Separated Values Text Format (File is returned as compressed zip file. The zip file contains the specified file format csv and a text README file.) OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| frequency | No | An optional parameter that indicates a lower frequency to aggregate values to. The FRED frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series). In FRED, the highest frequency data is daily, and the lowest frequency data is annual. There are 3 aggregation methods available- average, sum, and end of period. See the aggregation_method parameter. string, optional, default: no value for no frequency aggregation One of the following values: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem' Frequencies without period descriptions: d = Daily w = Weekly bw = Biweekly m = Monthly q = Quarterly sa = Semiannual a = Annual Frequencies with period descriptions: wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday Note that an error will be returned if a frequency is specified that is higher than the native frequency of the series. For instance if a series has the native frequency 'Monthly' (as returned by the fred/series request), it is not possible to aggregate the series to the higher 'Daily' frequency using the frequency parameter value 'd'. No frequency aggregation will occur if the frequency specified by the frequency parameter matches the native frequency [Import field summary truncated to fit the backend description limit. Complete original text is retained in officialOperation.parameters[].originalText and the documentation.] | |
| series_id | Yes | The id for a series. string, required | |
| sort_order | No | Sort results is ascending or descending observation_date order. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| output_type | No | An integer that indicates an output type. integer, optional, default: 1 One of the following values: '1', '2', '3', '4' 1 = Observations by Real-Time Period 2 = Observations by Vintage Date, All Observations 3 = Observations by Vintage Date, New and Revised Observations Only 4 = Observations, Initial Release Only For output types '2' and '3', some XML attribute names start with the series ID which may have a first character that is a number (i.e. 0 through 9). In this case only, the XML attribute name starts with an underscore then the series ID in order to avoid invalid XML. If the series ID starts with a letter (i.e. A through Z) then an underscore is not prepended. For more information, read: https://alfred.stlouisfed.org/help/downloaddata#outputformats | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods, vintage_dates. YYYY-MM-DD formatted string, optional, default: today's date | |
| vintage_dates | No | A comma separated string of YYYY-MM-DD formatted dates in history (e.g. 2000-01-01,2005-02-24). Vintage dates are used to download data as it existed on these specified dates in history. Vintage dates can be specified instead of a real-time period using realtime_start and realtime_end. Sometimes it may be useful to enter a vintage date that is not a date when the data values were revised. For instance you may want to know the latest available revisions on a particular date. Entering a vintage date is also useful to compare series on different releases with different release dates. string, optional, no vintage dates are set by default. Your query will be limited to a specific number of vintage dates depending on the series_id, file_type and output_type specified. output_type=2, series_id=USRECD: 110 csv, 55 xlsx output_type=2, any daily series: 450 csv, 225 xlsx any output_type or other series: 1000 csv, 1000 xlsx, 2000 json, 2000 xml | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods, vintage_dates. YYYY-MM-DD formatted string, optional, default: today's date | |
| observation_end | No | The end of the observation period. YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available) | |
| observation_start | No | The start of the observation period. YYYY-MM-DD formatted string, optional, default: 1776-07-04 (earliest available) | |
| aggregation_method | No | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. string, optional, default: avg One of the following values: 'avg', 'sum', 'eop' avg = Average sum = Sum eop = End of Period |
fred_get_fred_series_releaseFRED — Get Series ReleaseInspect
FRED — Get Series Release Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| series_id | Yes | The id for a series. string, required | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_series_searchFRED — Search Economic SeriesInspect
FRED — Search Economic Series Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'search_rank', 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity'. optional, default: If the value of search_type is 'full_text' then the default value of order_by is 'search_rank'. If the value of search_type is 'series_id' then the default value of order_by is 'series_id'. | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names that series match all of. String, optional, no filtering by tags by default Example value: 'usa;m2'. Filter results to series having both tags 'usa' and 'm2'. See the related request fred/tags. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: If order_by is equal to 'search_rank' or 'popularity', then the default value of sort_order is 'desc'. Otherwise, the default sort order is 'asc'. | |
| search_text | Yes | The words to match against economic data series. | |
| search_type | No | Determines the type of search to perform. One of the following strings: 'full_text', 'series_id'. 'full_text' searches series attributes title, units, frequency, and tags by parsing words into stems. This makes it possible for searches like 'Industry' to match series containing related words such as 'Industries'. Of course, you can search for multiple words like 'money' and 'stock'. Remember to url encode spaces (e.g. 'money%20stock'). 'series_id' performs a substring search on series IDs. Searching for 'ex' will find series containing 'ex' anywhere in a series ID. '*' can be used to anchor searches and match 0 or more of any character. Searching for 'ex*' will find series containing 'ex' at the beginning of a series ID. Searching for '*ex' will find series containing 'ex' at the end of a series ID. It's also possible to put an '*' in the middle of a string. 'm*sl' finds any series starting with 'm' and ending with 'sl'. optional, default: full_text. | |
| filter_value | No | The value of the filter_variable attribute to filter results by. String, optional, no filter by default | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| filter_variable | No | The attribute to filter results by. One of the following strings: 'frequency', 'units', 'seasonal_adjustment'. optional, no filter by default | |
| exclude_tag_names | No | A semicolon delimited list of tag names that series match none of. String, optional, no filtering by tags by default. Example value: 'discontinued;m1'. Filter results to series having neither tag 'discontinued' nor tag 'm1'. Parameter exclude_tag_names requires that parameter tag_names also be set to limit the number of matching series. |
fred_get_fred_series_search_tagsFRED — Get Tags for Series SearchInspect
Get the FRED tags for a series search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default: series_count | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names to only include in the response. See the related request fred/series/search/related_tags. String, optional, no filtering by tag names by default Example value: 'm1;m2'. This value filters results to only include tags 'm1' and 'm2'. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| tag_group_id | No | A tag group id to filter tags by type. String, optional, no filtering by tag group by default. One of the following: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src'. freq = Frequency gen = General or Concept geo = Geography geot = Geography Type rls = Release seas = Seasonal Adjustment src = Source | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| tag_search_text | No | The words to find matching tags with. String, optional, no filtering by search words by default. | |
| series_search_text | Yes | The words to match against economic data series. string, required |
fred_get_fred_series_tagsFRED — Get Series TagsInspect
FRED — Get Series Tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default: series_count | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| series_id | Yes | The id for a series. string, required | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_series_updatesFRED — List Updated SeriesInspect
Get economic data series sorted by when observations were updated on the FRED® server (attribute last_updated). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| end_time | No | End time for limiting results for a time range, can filter down to minutes YYYYMMDDHhmm formatted string, optional, , start_time is required if end_time is set< Example: 2018-03-02 2:20 would be 201803020220 | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| start_time | No | Start time for limiting results for a time range, can filter down to minutes YYYYMMDDHhmm formatted string, optional, end_time is required if start_time is set Example: 2018-03-02 14:20 would be 201803021420 | |
| filter_value | No | Limit results by geographic type of economic data series; namely 'macro', 'regional', and 'all'. String, optional, default: 'all' meaning no filter. One of the values: 'macro', 'regional', 'all' 'macro' limits results to macroeconomic data series. In general, these are series for entire countries that are not subregions of the United States. 'regional' limits results to series for parts of the US; namely, series for US states, counties, and Metropolitan Statistical Areas (MSA). 'all' does not filter results. | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_series_vintagedatesFRED — Get Series Vintage DatesInspect
Get the dates in history when a series' data values were revised or new data values were released. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 10000, optional, default: 10000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| series_id | Yes | The id for a series. string, required | |
| sort_order | No | Sort results is ascending or descending vintage_date order. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available) | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: 1776-07-04 (earliest available) |
fred_get_fred_sourceFRED — Get Data SourceInspect
FRED — Get Data Source Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| source_id | Yes | The id for a source. integer, required | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_source_releasesFRED — Get Source ReleasesInspect
FRED — Get Source Releases Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'release_id', 'name', 'press_release', 'realtime_start', 'realtime_end'. optional, default: release_id | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| source_id | Yes | The id for a source. integer, required | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_sourcesFRED — List Data SourcesInspect
FRED — List Data Sources Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'source_id', 'name', 'realtime_start', 'realtime_end'. optional, default: source_id | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_tagsFRED — Search TagsInspect
Get FRED tags. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default: series_count | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names to only include in the response. See the related request fred/related_tags. String, optional, no filtering by tag names by default Example value: 'gdp;oecd'. This value filters results to only include tags 'gdp' and 'oecd'. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| search_text | No | The words to find matching tags with. String, optional, no filtering by search words by default. | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| tag_group_id | No | A tag group id to filter tags by type. String, optional, no filtering by tag group by default. One of the following: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src', 'cc'. freq = Frequency gen = General or Concept geo = Geography geot = Geography Type rls = Release seas = Seasonal Adjustment src = Source cc = Citation & Copyright | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date |
fred_get_fred_tags_seriesFRED — Get Series Matching TagsInspect
FRED — Get Series Matching Tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity'. optional, default: series_id | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | Yes | A semicolon delimited list of tag names that series match all of. String, required, no default value. Example value: 'slovenia;food'. Filter results to series having both tags 'slovenia' and 'food'. See the related request fred/tags. | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| exclude_tag_names | No | A semicolon delimited list of tag names that series match none of. String, optional, no default value. Example value: 'alchohol;quarterly'. Filter results to series having neither tag 'alchohol' nor tag 'quarterly'. |
fred_get_geofred_regional_dataFRED — Get Regional Economic DataInspect
This request returns a cross section of regional data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | The date you want to pull a series group data from. YYYY-MM-DD formatted string, required | |
| units | Yes | The units of the series you want to pull. string, required | |
| season | Yes | The seasonality of the series group. string, required, five possible SA (Seasonally Adjusted), NSA (Not Seasonally Adjusted), SSA (Smoothed Seasonally Adjusted), SAAR (Seasonally Adjusted Annual Rate), or NSAAR (Not Seasonally Adjusted Annual Rate) | |
| file_type | Yes | A key or file extension that indicates the type of file to send. One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml (xml is not available for county data). json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| frequency | No | Frequency automatically assigns the default frequency of the map when using the Request Wizard above. The parameter can be used as a frequency aggregation feature. The maps frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series). In maps, the highest frequency data is daily, and the lowest frequency data is annual. There are 3 aggregation methods available- average, sum, and end of period. See the aggregation_method parameter. string One of the following values: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem' Frequencies without period descriptions: d = Daily w = Weekly bw = Biweekly m = Monthly q = Quarterly sa = Semiannual a = Annual Frequencies with period descriptions: wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday | |
| start_date | No | The start date you want to request series group data from. This allows you to pull a range of data YYYY-MM-DD formatted string, optional | |
| region_type | Yes | The region you want to pull data for. string, required One of the following values: bea msa frb necta state country county censusregion | |
| series_group | Yes | The ID for a group of series found in FRED. string, required | |
| transformation | No | A key that indicates a data value transformation. string, optional, default: lin (No transformation) One of the following values: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log' lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log For unit transformation formulas, see: https://alfred.stlouisfed.org/help#growth_formulas | |
| aggregation_method | No | string, optional, default: avg One of the following values: 'avg', 'sum', 'eop' avg = Average sum = Sum eop = End of Period |
fred_get_geofred_series_dataFRED — Get Map Series Regional DataInspect
FRED — Get Map Series Regional Data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | The date you want to request series group data from. YYYY-MM-DD formatted string, optional | |
| file_type | Yes | A key or file extension that indicates the type of file to send. One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml (xml is not available for county data). json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| series_id | Yes | The FRED series_id you want to request maps data for. Not all series that are in FRED have geographical data. string, required | |
| start_date | No | The start date you want to request series group data from. This allows you to pull a range of data YYYY-MM-DD formatted string, optional |
fred_get_geofred_series_groupFRED — Get Map Series GroupInspect
FRED — Get Map Series Group Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| file_type | Yes | A key or file extension that indicates the type of file to send. One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| series_id | Yes | The FRED series id you want to request maps meta information for. Not all series that are in FRED have geographical data. string, required |
fred_get_geofred_shapes_fileFRED — Get Geographic Shape GeoJSONInspect
FRED — Get Geographic Shape GeoJSON Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| shape | Yes | The type of shape you want to pull GeoJSON data for. Available Shape Types: bea (Bureau of Economic Anaylis Region) msa (Metropolitan Statistical Area) frb (Federal Reserve Bank Districts) necta (New England City and Town Area) state country county (USA Counties) censusregion (US Census Regions) censusdivision (US Census Divisons) |
gang_get_api_agents_idGang — An agent's record: launches, trades, notes and how they were followedInspect
查看一个 Agent 的公开发行、交易、笔记及跟随统计。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A 0x address, or an Agent ID handle (lazy or lazy.ai) |
gang_get_api_agents_id_launchesGang — Tokens the agent launched, newest firstInspect
列出一个 Agent 发行的代币,按新到旧分页。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A 0x address, or an Agent ID handle (lazy or lazy.ai) | |
| limit | No | ||
| offset | No |
gang_get_api_agents_id_positionsGang — Tokens the agent still holds per its curve / sale trades, with cost, value and PnLInspect
查看 Agent 从曲线或销售交易推算的持仓、成本与盈亏。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A 0x address, or an Agent ID handle (lazy or lazy.ai) |
gang_get_api_agents_id_tradesGang — The agent's curve / sale trades, newest firstInspect
查看一个 Agent 的曲线或销售交易;noted=1 可筛选有笔记的交易。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A 0x address, or an Agent ID handle (lazy or lazy.ai) | |
| limit | No | ||
| noted | No | Only trades carrying a visible note | |
| offset | No |
gang_get_api_featuredGang — The featured token of the week and this week's invite boardInspect
查询本周精选代币及邀请榜。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
gang_get_api_fly_tokens_addrGang — 查看一项 Mint Flywheel 销售的阶段、配额、价格、保护与收益。Inspect
查看一项 Mint Flywheel 销售的阶段、配额、价格、保护与收益。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addr | Yes | 官方指南 URL 中的代币地址 |
gang_get_api_fly_tokens_addr_eventsGang — 查看 Mint Flywheel 销售事件列表。Inspect
查看 Mint Flywheel 销售事件列表。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addr | Yes | 官方指南 URL 中的代币地址 | |
| limit | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 | |
| offset | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 |
gang_get_api_fly_tokens_addr_holdersGang — 查看 Mint Flywheel 代币持有者列表。Inspect
查看 Mint Flywheel 代币持有者列表。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addr | Yes | 官方指南 URL 中的代币地址 | |
| limit | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 | |
| offset | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 |
gang_get_api_fly_tokens_addr_participantsGang — 查看 Mint Flywheel 销售参与者。Inspect
查看 Mint Flywheel 销售参与者。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addr | Yes | 官方指南 URL 中的代币地址 | |
| limit | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 | |
| offset | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 |
gang_get_api_fly_tokens_addr_position_walletGang — 查看公开钱包在该 Mint Flywheel 销售中的配额与收益。Inspect
查看公开钱包在该 Mint Flywheel 销售中的配额与收益。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addr | Yes | 官方指南 URL 中的代币地址 | |
| wallet | Yes | 官方指南 URL 中的钱包地址 |
gang_get_api_fly_tokens_addr_referralsGang — 查看该 Mint Flywheel 销售的邀请榜。Inspect
查看该 Mint Flywheel 销售的邀请榜。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addr | Yes | 官方指南 URL 中的代币地址 | |
| limit | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 | |
| offset | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 |
gang_get_api_fly_tokens_addr_tradesGang — 查看 Mint Flywheel 销售的交易列表。Inspect
查看 Mint Flywheel 销售的交易列表。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| addr | Yes | 官方指南 URL 中的代币地址 | |
| side | No | 交易方向筛选。 | |
| sort | No | 交易排序。 | |
| limit | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 | |
| offset | No | 官方客户端分页参数;default 是客户端默认值,未声明服务端正式范围。 |
gang_get_api_marketGang — The market board, every track mergedInspect
查看市场列表,按热度、市值、新上线、毕业进度或分红排序。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| at | No | The `at` of a previous page: keeps paging the same snapshot | |
| kind | No | ||
| sort | No | An unknown value falls back to hot | |
| limit | No | ||
| bonded | No | Only tokens whose creator bond is active | |
| offset | No |
gang_get_api_notesGang — Agents' public trade notes and launch manifestos, newest firstInspect
筛选和分页读取 Agent 的公开交易笔记及发行宣言。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | ||
| sort | No | ||
| agent | No | Addresses or handles, comma-separated (at most 20) | |
| limit | No | ||
| token | No | ||
| before | No | The `next` of the previous page | |
| minHit | No | Authors whose judged notes in the last 30 days hit at least this often | |
| offset | No | ||
| status | No | ||
| followable | No | Only notes that can be followed now (buy notes and manifestos within 24h of the trade, before graduation) | |
| withExpired | No |
gang_get_api_notes_txGang — One note by the tx that carried itInspect
按笔记所绑定的交易哈希读取单条笔记。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tx | Yes |
gang_get_api_openapi_jsonGang — This documentInspect
下载官方 OpenAPI 机器定义,供工具发现和接口契约核对。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
gang_get_api_ref_eligibleGang — Whether a wallet can still be invited, and the referrer a ref namesInspect
查询指定公开钱包是否仍可受邀,以及 ref 对应的邀请人。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ref | No | An address or a .ai handle | |
| wallet | Yes |
gang_get_api_searchGang — Tokens by name, symbol or address prefix (every track)Inspect
按名称、符号或地址前缀发现代币,获得后续查询需要的完整地址。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | At least 2 characters (fewer: an empty list) |
gang_get_api_statsGang — Site totals and the USD price of every quoteInspect
读取站点统计和各报价代币的美元参考价格。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
gang_get_api_trendingGang — What to look at now: tokens most bought by agents in the last 6 hours, and followable notes by proven authorsInspect
发现近期不同 Agent 买入最多的代币及符合条件的公开笔记。 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| testnet | No | Let other chains' V3 / fair / fly rows in |
geckoterminal_get_api_v2_networksGeckoTerminal — Supported Networks List (ID Map)Inspect
This endpoint allows you to query all the supported networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) |
geckoterminal_get_api_v2_networks_network_dexesGeckoTerminal — Supported Dexes List by Network (ID Map)Inspect
This endpoint allows you to query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) |
geckoterminal_get_api_v2_networks_network_dexes_dex_poolsGeckoTerminal — Top Pools by DexInspect
This endpoint allows you to query all the top pools based on the provided network and decentralized exchange (DEX) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dex | Yes | DEX ID<br>*refers to [/networks/{network}/dexes](/api/v2/networks/eth/dexes) | |
| page | No | page through results (maximum: 10) | |
| sort | No | sort the pools by field | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| include_gt_community_data | No | include GT community data |
geckoterminal_get_api_v2_networks_network_new_poolsGeckoTerminal — New Pools by NetworkInspect
This endpoint allows you to query all the latest pools based on provided network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| include_gt_community_data | No | include GT community data |
geckoterminal_get_api_v2_networks_network_poolsGeckoTerminal — Top Pools by NetworkInspect
This endpoint allows you to query all the top pools based on the provided network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) | |
| sort | No | sort the pools by field | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| include_gt_community_data | No | include GT community data |
geckoterminal_get_api_v2_networks_network_pools_addressGeckoTerminal — Specific Pool Data by Pool AddressInspect
This endpoint allows you to query the specific pool based on the provided network and pool address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | pool address | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| include_composition | No | include pool composition | |
| include_volume_breakdown | No | include volume breakdown |
geckoterminal_get_api_v2_networks_network_pools_multi_addressesGeckoTerminal — Multiple Pools Data by Pool AddressesInspect
This endpoint allows you to query multiple pools based on the provided network and pool address Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| addresses | Yes | pool contract address, comma-separated if more than one pool contract address (up to 30 addresses) | |
| include_composition | No | include pool composition | |
| include_volume_breakdown | No | include volume breakdown |
geckoterminal_get_api_v2_networks_network_pools_pool_address_ohlGeckoTerminal — Pool OHLCV chart by Pool AddressInspect
This endpoint allows you to get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | number of OHLCV results to return, maximum 1000 | |
| token | No | return OHLCV for token<br>use this to invert the chart<br>Available values: 'base', 'quote', or token address | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| currency | No | return OHLCV in USD or quote token | |
| aggregate | No | time period to aggregate for each OHLCV<br><br><b>Available values (day):</b> `1`<br><br><b>Available values (hour):</b> `1`, `4`, `12`<br><br><b>Available values (minute):</b> `1`, `5`, `15` | |
| timeframe | Yes | timeframe of the OHLCV chart | |
| pool_address | Yes | pool contract address | |
| before_timestamp | No | return OHLCV data before this timestamp (integer seconds since epoch) | |
| include_empty_intervals | No | include empty intervals with no trade data |
geckoterminal_get_api_v2_networks_network_tokens_addressGeckoTerminal — Token Data by Token AddressInspect
This endpoint allows you to query specific token data based on the provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | token contract address | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `top_pools` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| include_composition | No | include pool composition | |
| include_inactive_source | No | include inactive pools when sourcing for token's top pool |
geckoterminal_get_api_v2_networks_network_tokens_address_infoGeckoTerminal — Token Info by Token AddressInspect
This endpoint allows you to query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | token contract address | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) |
geckoterminal_get_api_v2_networks_network_tokens_token_address_pGeckoTerminal — Top Pools by Token AddressInspect
This endpoint allows you to query top pools based on the provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) | |
| sort | No | sort the pools by field | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| token_address | Yes | token contract address | |
| include_inactive_source | No | include inactive pools when sourcing for token's top pool |
geckoterminal_get_api_v2_networks_network_trending_poolsGeckoTerminal — Trending Pools by NetworkInspect
This endpoint allows you to query the trending pools based on the provided network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| duration | No | duration to sort trending list by | |
| include_gt_community_data | No | include GT community data |
geckoterminal_get_api_v2_networks_new_poolsGeckoTerminal — New Pools ListInspect
This endpoint allows you to query all the latest pools across all networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex`, `network` | |
| include_gt_community_data | No | include GT community data |
geckoterminal_get_api_v2_networks_trending_poolsGeckoTerminal — Trending Pools ListInspect
This endpoint allows you to query all the trending pools across all networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex`, `network` | |
| duration | No | duration to sort trending list by | |
| include_gt_community_data | No | include GT community data |
geckoterminal_get_api_v2_search_poolsGeckoTerminal — Search PoolsInspect
This endpoint allows you to search for pools on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | page through results (maximum: 10) | |
| query | No | search query | |
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `base_token`, `quote_token`, `dex` | |
| network | No | network ID<br>*refers to [/networks](/api/v2/networks) |
geckoterminal_get_api_v2_simple_networks_network_token_price_addGeckoTerminal — Token Price by Token AddressesInspect
This endpoint allows you to get token price based on the provided token contract address on a network Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| network | Yes | network ID<br>*refers to [/networks](/api/v2/networks) | |
| addresses | Yes | token contract address, comma-separated if more than one token contract address (up to 30 addresses) | |
| include_24hr_vol | No | include 24hr volume | |
| mcap_fdv_fallback | No | return FDV if market cap is not available | |
| include_market_cap | No | include market capitalization | |
| include_inactive_source | No | include inactive pools when sourcing for token's top pool | |
| include_24hr_price_change | No | include 24hr price change | |
| include_total_reserve_in_usd | No | include total reserve in USD |
geckoterminal_get_api_v2_tokens_info_recently_updatedGeckoTerminal — Most Recently Updated Tokens ListInspect
This endpoint allows you to query 100 most recently updated tokens info of a specific network or across all networks on GeckoTerminal Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | attributes to include, comma-separated if more than one to include<br><br><b>Available values:</b> `network` | |
| network | No | network ID<br>*refers to [/networks](/api/v2/networks) |
goplus_get_api_v1_address_security_addressGoPlus — Malicious Address DetectionInspect
Check a wallet or contract address for known malicious activities. Optionally specify chain_id to obtain chain-specific contract information; missing classifications are not a safety guarantee. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | address | |
| chain_id | No | The chain_id of the blockchain. To check the corresponding blockchain name for a given chain_id, please visit: https://docs.gopluslabs.io/reference/response-details-9 |
goplus_get_api_v1_approval_security_chain_idGoPlus — Token Approval Spender SecurityInspect
Inspect a proposed token-approval spender for contract and malicious-behavior risks on the selected chain. This checks the spender; it does not list a wallet's existing approvals or revoke them. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | Chain id, (ETH: 1, BSC: 56, OKC: 66, Heco: 128, Polygon: 137, Fantom:250, Arbitrum: 42161, Avalanche: 43114) | |
| contract_addresses | Yes | Contract needs to be detected |
goplus_get_api_v1_nft_security_chain_idGoPlus — NFT SecurityInspect
Inspect an NFT contract and optionally a token_id for contract privileges, verification and security risks. The observed code=2 response contains partial data; null or missing fields remain unknown. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The chain_id of the blockchain."1" means Ethereum; "10" means Optimism;"25" means Cronos;"56" means BSC; "100" means Gnosis;"128" means HECO; "137" means Polygon; "250" means Fantom;"321" means KCC;"324" means zkSync Era; "201022" means FON;"42161" means Arbitrum; "43114" means Avalanche;"59144" means Linea Mainnet;"8453" Base;"5000" Mantle; | |
| token_id | No | tokenId | |
| contract_addresses | Yes | NFT contract address |
goplus_get_api_v1_phishing_siteGoPlus — Phishing Site DetectionInspect
Check whether a supplied URL or domain is recognized as a phishing site before a user opens a link or connects a wallet. A non-flagged result is not proof of safety. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Url |
goplus_get_api_v1_rugpull_detecting_chain_idGoPlus — Rug-pull Detection (Beta)Inspect
Inspect a DeFi contract for potential rug-pull risks on a supported chain. This beta detection reports risk indicators and does not replace a comprehensive contract audit. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | Chain id, (eth: 1, bsc: 56) | |
| contract_addresses | Yes | Defi protocol address |
goplus_get_api_v1_solana_token_securityGoPlus — Solana Token SecurityInspect
Inspect a Solana token mint for minting, freezing, upgrade-authority, holder and liquidity risks. Supply the native mint identifier; retain unknown and missing risk fields. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| contract_addresses | Yes | The contract address of solana tokens. |
goplus_get_api_v1_sui_token_securityGoPlus — Sui Token SecurityInspect
Inspect a Sui coin type for minting, contract-upgrade, metadata and permission risks. Supply the full package::module::TOKEN identifier and interpret permission values with the documented owner-cap semantics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| contract_addresses | Yes | The contract address of sui tokens. |
goplus_get_api_v1_supported_chainsGoPlus — Supported BlockchainsInspect
List blockchains supported by the selected GoPlus API function. Use the returned native chain IDs; support differs by function and the live list can differ from static documentation enums. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | API name. |
goplus_get_api_v1_token_security_chain_idGoPlus — Multi-Chain Token SecurityInspect
Inspect a token contract on a supported chain for contract permissions, trading restrictions, taxes, holders and liquidity risks. Results are keyed by contract identifier; null or missing indicators remain unknown. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain_id | Yes | The chain_id of the blockchain. To check the corresponding blockchain name for a given chain_id, please visit: https://docs.gopluslabs.io/reference/response-details-9 | |
| contract_addresses | Yes | The contract address of tokens. |
goplus_get_api_v2_nft1155_approval_security_chainidGoPlus — Wallet ERC-1155 Approval RisksInspect
List an EOA wallet's outstanding ERC-1155 approvals and associated NFT and spender risks on the selected chain. This read-only query does not revoke permissions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | Yes | chain id | |
| addresses | Yes | contract address |
goplus_get_api_v2_nft721_approval_security_chainidGoPlus — Wallet ERC-721 Approval RisksInspect
List an EOA wallet's outstanding ERC-721 approvals and associated NFT and spender risks on the selected chain. Distinguish individual token approvals from approval-for-all permissions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | Yes | chain id | |
| addresses | Yes | contract address |
goplus_get_api_v2_token_approval_security_chainidGoPlus — Wallet ERC-20 Approval RisksInspect
List an EOA wallet's outstanding ERC-20 approvals and associated token, spender, allowance and transaction risks on the selected chain. This read-only query does not revoke approvals. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | Yes | chain id | |
| addresses | Yes | contract address |
harvestapi_get_linkedin_account_searchSearch LinkedIn accountsInspect
Search LinkedIn companies by advanced filters (headcount and its growth, revenue, department headcount, hiring, recent activities, Fortune lists) with inclusion and exclusion criteria Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (clamped at 100). 25 results per page | |
| search | No | Search query. Fuzzy search, supports LinkedIn's search operators | |
| fortune | No | Filter by Fortune 500 rank. Comma-separated. Available values: 50 (Fortune 50), 51_100, 101_250, 251_500 | |
| sessionId | No | Session ID to use for the search. See https://docs.harvestapi.io/linkedin-api-reference/leads/search-leads#session-id for details. | |
| industryIds | No | Filter by industry IDs. Comma-separated (max 70). Full list: https://github.com/HarvestAPI/linkedin-industry-codes-v2/blob/main/linkedin_industry_code_v2_all_eng_with_header.csv | |
| annualRevenue | No | Filter by annual revenue in millions, as `min-max;currency` (USD by default). Examples: `1-10;USD`, `0.5-1000` | |
| numOfFollowers | No | Filter by number of followers. Comma-separated. Available values: 1-50, 51-100, 101-1000, 1001-5000, 5001+ | |
| companyHeadcount | No | Filter by company headcount. Comma-separated. Available values: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+ | |
| jobOpportunities | No | Set to `HIRING_ON_LINKEDIN` to find companies that are hiring on LinkedIn | |
| accountActivities | No | Filter by recent company activities. Comma-separated. Available values: SENIOR_LEADERSHIP_CHANGES_LAST_3_MONTHS, FUNDING_EVENTS_PAST_12_MONTHS | |
| headquarterGeoIds | No | Filter by headquarters LinkedIn Geo ID. Comma-separated (max 70). Use /linkedin/geo-id-search to find IDs | |
| excludeIndustryIds | No | Industry IDs to exclude. Comma-separated (max 70) | |
| departmentHeadcount | No | Filter by the headcount of a department, as `min-max;department`. Example: `10-100;Engineering`. Departments: Accounting, Administrative, Arts and Design, Business Development, Community and Social Services, Consulting, Education, Engineering, Entrepreneurship, Finance, Healthcare Services, Human Resources, Information Technology, Legal, Marketing, Media and Communication, Military and Protective Services, Operations, Product Management, Program and Project Management, Purchasing, Quality Assurance, Real Estate, Research, Sales, Support | |
| headquarterLocations | No | Filter by headquarters location text. Comma-separated (max 70) | |
| companyHeadcountGrowth | No | Filter by company headcount growth in percent, as `min-max`. Example: `1-100` | |
| excludeCompanyHeadcount | No | Company headcounts to exclude. Comma-separated. Same values as `companyHeadcount` | |
| excludeHeadquarterGeoIds | No | Headquarters Geo IDs to exclude. Comma-separated (max 70) | |
| departmentHeadcountGrowth | No | Filter by the headcount growth of a department in percent, as `min-max;department`. Example: `5-50;Sales`. Same departments as `departmentHeadcount` | |
| excludeHeadquarterLocations | No | Headquarters locations to exclude. Comma-separated (max 70) |
harvestapi_get_linkedin_comment_reactionsGet reactions of LinkedIn post commentInspect
Get reactions of LinkedIn post comment by comment URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL of the LinkedIn comment (required) | |
| page | No | Page number for pagination. Default is 1 |
harvestapi_get_linkedin_company_postsGet LinkedIn company postsInspect
Get LinkedIn company posts by company URL, ID, or universal name. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| company | No | Filter posts by this company URL or universal name or company ID | |
| postedLimit | No | Filter posts by maximum posted date. Supported values: '24h', 'week', 'month'. Since LinkedIn doesn't offer a way to filter by date, the filtering will be done on our side, due to that the pagination might have incorrect values, because pagination is returned by LinkedIn without applying the postedLimit filter | |
| paginationToken | No | Required if it was returned by the previous page. Otherwise the page will always be 1 (on LinkedIn side). Doesn't apply for all queries, usually profile posts return this token | |
| scrapePostedLimit | No | Post-Filter posts by maximum posted date. Supported values: '1h', '24h', 'week','month', '3months', '6months', 'year'. This parameter will be applied after receiving results from LinkedIn, the filtering will be done on our side |
harvestapi_get_linkedin_company_searchSearch LinkedIn companiesInspect
Retrieve a list of LinkedIn companies matching the specified search criteria. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| geoId | No | Filter by location as LinkedIn Geo ID. Overrides the location query param. Use the /linkedin/geo-id-search endpoint to find the Geo ID | |
| search | No | Keywords to search for in company names. | |
| location | No | Filter companies by location. | |
| industryId | No | Filter by industry ID. One value or multiple comma-separated industry IDs. Full list of IDs: https://github.com/HarvestAPI/linkedin-industry-codes-v2/blob/main/linkedin_industry_code_v2_all_eng.csv | |
| companySize | No | Filter by company size. One value or multiple comma-separated. Supported values: '1-10', '11-50', '51-200', '201-500', '501-1000', '1001-5000', '5001-10000', '10001+' |
harvestapi_get_linkedin_jobGet the LinkedIn job detailsInspect
Get the LinkedIn job details by job ID or URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL of the LinkedIn job (optional) | |
| jobId | No | ID of the LinkedIn job (optional) |
harvestapi_get_linkedin_job_searchSearch LinkedIn jobsInspect
Search LinkedIn jobs by title, company, location, and more. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| geoId | No | Filter by location as LinkedIn Geo ID. Overrides the location query param. Use the /linkedin/geo-id-search endpoint to find the Geo ID | |
| salary | No | Filter by salary range. Supported values: '40k+', '60k+', '80k+', '100k+', '120k+', '140k+', '160k+', '180k+', '200k+' | |
| search | No | Search jobs by title | |
| sortBy | No | Sort by field. Supported values: 'relevance', 'date' | |
| location | No | Filter by location text | |
| companyId | No | Filter by company ID. One value or multiple comma-separated. | |
| easyApply | No | Set this parameter to 'true' filter jobs with Easy Apply option or 'false' to exclude. Values can be 'true' or 'false' | |
| functionId | No | Filter by job function ID. One value or multiple comma-separated function IDs. Full list of IDs: https://github.com/HarvestAPI/apify-linkedin-profile-search/blob/main/.actor/input_schema.json#L142 | |
| industryId | No | Filter by industry ID. One value or multiple comma-separated industry IDs. Full list of IDs: https://github.com/HarvestAPI/linkedin-industry-codes-v2/blob/main/linkedin_industry_code_v2_all_eng.csv | |
| postedLimit | No | Filter posts by maximum posted date. Supported values: '24h', 'week', 'month' | |
| workplaceType | No | Filter by workplace type. One or multiple values comma-separated. Supported values: 'office', 'hybrid', 'remote' | |
| employmentType | No | Filter by employment type. One or multiple values comma-separated. Supported values: 'full-time', 'part-time', 'contract', 'temporary', 'internship' | |
| experienceLevel | No | Filter by experience level. One or multiple values comma-separated. Supported values: 'internship', 'entry', 'associate', 'mid-senior', 'director', 'executive' | |
| under10Applicants | No | Include this parameter to filter jobs with under 10 applicants |
harvestapi_get_linkedin_lead_searchSearch LinkedIn leadsInspect
Search LinkedIn profile leads by filters with advanced inclusion and exclusion criteria Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (clamped at 100) | |
| geoIds | No | Filter by LinkedIn Geo ID. Comma-separated. Overrides location param. Use /linkedin/geo-id-search to find IDs | |
| search | No | Search query. Fuzzy search, supports LinkedIn's search operators | |
| schools | No | Filter by school IDs or URLs. Comma-separated (max 50) | |
| lastNames | No | Filter by last names. Comma-separated (max 70) | |
| locations | No | Filter by location text. Comma-separated (max 70) | |
| sessionId | No | Session ID to use for the search. See https://docs.harvestapi.io/linkedin-api-reference/leads/search-leads#session-id for details. | |
| firstNames | No | Filter by first names. Comma-separated (max 70) | |
| functionIds | No | Filter by job function IDs. Comma-separated. https://github.com/HarvestAPI/harvestapi-sdk/blob/main/packages/scraper/README.md#functionids | |
| industryIds | No | Filter by industry IDs. Comma-separated (max 70). Full list: https://github.com/HarvestAPI/linkedin-industry-codes-v2/blob/main/linkedin_industry_code_v2_all_eng_with_header.csv | |
| salesNavUrl | No | LinkedIn Sales Navigator search URL to use for the search. This will override all other search parameters, except the `page` parameter. For pagination, please pass the `page` query parameter separately. Note: the scraper doesn't scrape the URL directly, it will parse the URL, sanitize and validate params. It supports all parameters currently, but if LinkedIn adds new parameters in the future, they might not be supported until we update the API. Please contact us in this case. | |
| excludeGeoIds | No | Geo IDs to exclude from search. Comma-separated (max 70) | |
| pastCompanies | No | Filter by past company IDs or URLs. Comma-separated (max 50) | |
| pastJobTitles | No | Filter by past job titles. Comma-separated (max 70) | |
| excludeSchools | No | Schools to exclude. Comma-separated (max 50) | |
| usePrivatePool | No | Set to true to use your private pool of resources (if available) | |
| companyHeadcount | No | Filter by company headcount. Comma-separated. https://github.com/HarvestAPI/harvestapi-sdk/blob/main/packages/scraper/README.md#companyheadcount | |
| currentCompanies | No | Filter by current company IDs or URLs. Comma-separated (max 50) | |
| currentJobTitles | No | Filter by current job titles. Comma-separated (max 70) | |
| excludeLocations | No | Locations to exclude from search. Comma-separated (max 70) | |
| postedOnLinkedin | No | Filter leads who posted on LinkedIn in the last 30 days | |
| profileLanguages | No | Filter by profile languages. Comma-separated. https://github.com/HarvestAPI/harvestapi-sdk/blob/main/packages/scraper/README.md#profilelanguages | |
| requiredAccountId | No | If we provide you a private pool of accounts, you can use this parameter to specify which account should be used for this request. | |
| seniorityLevelIds | No | Filter by seniority level IDs. Comma-separated. https://github.com/HarvestAPI/harvestapi-sdk/blob/main/packages/scraper/README.md#senioritylevelids | |
| excludeFunctionIds | No | Function IDs to exclude. Comma-separated (max 30) | |
| excludeIndustryIds | No | Industry IDs to exclude. Comma-separated (max 70) | |
| recentlyChangedJobs | No | Filter leads who recently changed jobs in the last 90 days. | |
| excludePastCompanies | No | Past companies to exclude. Comma-separated (max 50) | |
| excludePastJobTitles | No | Past job titles to exclude. Comma-separated (max 70) | |
| yearsOfExperienceIds | No | Filter by years of experience IDs. Comma-separated. https://github.com/HarvestAPI/harvestapi-sdk/blob/main/packages/scraper/README.md#yearsofexperienceids | |
| excludeCurrentCompanies | No | Current companies to exclude. Comma-separated (max 50) | |
| excludeCurrentJobTitles | No | Current job titles to exclude. Comma-separated (max 70) | |
| excludeSeniorityLevelIds | No | Seniority level IDs to exclude. Comma-separated (max 20) | |
| yearsAtCurrentCompanyIds | No | Filter by years at current company IDs. Comma-separated. https://github.com/HarvestAPI/harvestapi-sdk/blob/main/packages/scraper/README.md#yearsatcurrentcompanyids | |
| companyHeadquarterLocations | No | Filter by company headquarter location text. Comma-separated (max 70) | |
| excludeCompanyHeadquarterLocations | No | Company headquarter locations to exclude from search. Comma-separated (max 70) |
harvestapi_get_linkedin_postGet LinkedIn post detailsInspect
Get LinkedIn post details by post URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL of the LinkedIn post (required) |
harvestapi_get_linkedin_post_comment_repliesGet replies of LinkedIn post commentInspect
Get replies of LinkedIn post comment by comment URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL of the LinkedIn comment (required) | |
| paginationToken | No | Use this token from the previous page response. |
harvestapi_get_linkedin_post_commentsGet comments of LinkedIn postInspect
Get comments of LinkedIn post by post URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. Default is 1 | |
| post | No | URL of the LinkedIn post (required) | |
| sortBy | No | Sort comments by field. Supported values: 'relevance', 'date' | |
| paginationToken | No | Required only if sortBy is 'relevance' and page > 1. Use this token from the previous page response. |
harvestapi_get_linkedin_post_reactionsGet reactions of LinkedIn postInspect
Get reactions of LinkedIn post by post URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. Default is 1 | |
| post | No | URL of the LinkedIn post (required) | |
| sortBy | No | Sort comments by field. Supported values: 'relevance', 'date' |
harvestapi_get_linkedin_post_searchSearch LinkedIn postsInspect
Search LinkedIn posts by keywords, author, date range, and more. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| group | No | Group LinkedIn URL or Group ID | |
| search | No | Keywords to search for in posts | |
| sortBy | No | Sort by field. Supported values: 'relevance', 'date' | |
| company | No | Filter posts by this company URL(s) or company ID(s) (comma-separated). Note: LinkedIn returns fewer results per company when using post search. To extract all posts by a company, use the /linkedin/company-posts endpoint | |
| profile | No | Filter posts by author's profile URL(s) or public identifier(s) or profile ID(s) (comma-separated). Note: LinkedIn returns fewer results per profile when using post search. To extract all posts by a profile, use the /linkedin/profile-posts endpoint | |
| contentType | No | Filter by content type. Supported values: 'videos', 'images', 'live_videos', 'documents', 'collaborative_articles', 'jobs' | |
| postedLimit | No | Filter posts by maximum posted date. Supported values: '24h', 'week', 'month'. This parameter will be sent to LinkedIn, the filtering will be done on their side | |
| authorKeywords | No | Filter by keywords in authors' profiles | |
| authorsCompany | No | List of LinkedIn companies where authors of posts work (comma-separated). It supports company URLs and IDs. | |
| paginationToken | No | Required if it was returned by the previous page. Otherwise the page will always be 1 (on LinkedIn side). Doesn't apply for all queries, usually profile posts return this token | |
| mentioningMember | No | Filter posts mentioning this LinkedIn profile URL or ID (comma-separated). It supports profile URLs and IDs. | |
| authorsIndustryId | No | List of LinkedIn industry IDs of authors' companies (comma-separated). It supports industry IDs. Full list of industry IDs: https://github.com/HarvestAPI/linkedin-industry-codes-v2/blob/main/linkedin_industry_code_v2_all_eng.csv | |
| mentioningCompany | No | Filter posts mentioning this LinkedIn company URL or ID (comma-separated). It supports company URLs and IDs. | |
| scrapePostedLimit | No | Post-Filter posts by maximum posted date. Supported values: '1h', '24h', 'week','month', '3months', '6months', 'year'. This parameter will be applied after receiving results from LinkedIn, the filtering will be done on our side |
harvestapi_get_linkedin_profile_commentsGet comments of LinkedIn profileInspect
Get comments of LinkedIn profile by post URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. Default is 1 | |
| profile | No | URL of the LinkedIn profile or public identifier or profile ID | |
| postedLimit | No | Filter posts by maximum posted date. Supported values: '24h', 'week', 'month' | |
| paginationToken | No | Required for pages > 1. Use this token from the previous page response. |
harvestapi_get_linkedin_profile_postsGet LinkedIn profile postsInspect
Get LinkedIn profile posts by profile URL, ID, or public identifier. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| profile | No | Filter posts by author's profile URL or public identifier or profile ID. | |
| postedLimit | No | Filter posts by maximum posted date. Supported values: '24h', 'week', 'month'. Since LinkedIn doesn't offer a way to filter by date, the filtering will be done on our side, due to that the pagination might have incorrect values, because pagination is returned by LinkedIn without applying the postedLimit filter | |
| paginationToken | No | Required if it was returned by the previous page. Otherwise the page will always be 1 (on LinkedIn side). Doesn't apply for all queries, usually profile posts return this token | |
| scrapePostedLimit | No | Post-Filter posts by maximum posted date. Supported values: '1h', '24h', 'week','month', '3months', '6months', 'year'. This parameter will be applied after receiving results from LinkedIn, the filtering will be done on our side |
harvestapi_get_linkedin_profile_reactionsGet reactions of LinkedIn profileInspect
Get reactions of LinkedIn profile by profile URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. Default is 1 | |
| profile | No | URL of the LinkedIn profile or public identifier or profile ID. | |
| paginationToken | No | Required for pages > 1. Use this token from the previous page response. |
harvestapi_get_linkedin_profile_searchSearch LinkedIn profilesInspect
Search LinkedIn profiles by name, company, location, and more Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, use for pagination | |
| geoId | No | Filter by location as LinkedIn Geo ID. Overrides the location query param. Use the /linkedin/geo-id-search endpoint to find the Geo ID | |
| title | No | Filter by title | |
| school | No | Filter by school ID or School URL. One value or multiple comma-separated | |
| search | No | Search profiles by name | |
| lastName | No | Filter by last name | |
| location | No | Filter by location text | |
| firstName | No | Filter by first name | |
| followerOf | No | Filter profiles that are followers of a LinkedIn profile. Provide the profile URL or ID. One value or multiple comma-separated | |
| industryId | No | Filter by industry ID. One value or multiple comma-separated | |
| pastCompany | No | Filter by past company ID or Company URL. One value or multiple comma-separated | |
| currentCompany | No | Filter by company ID or Company URL. One value or multiple comma-separated | |
| keywordsSchool | No | Filter by keywords in school name | |
| keywordsCompany | No | Filter by keywords in company name |
hunter_get_v2_combined_findHunter — Combined Enrichment (GET)Inspect
Enrich a person and company Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| No | Email address to enrich. | ||
| clearbit_format | No | When set to any non-empty value, return the Clearbit-compatible response shape. | |
| linkedin_handle | No | LinkedIn profile handle to enrich. |
hunter_get_v2_companies_findHunter — Company Enrichment (GET)Inspect
Enrich a company Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | The domain name for which you to find associated information. | |
| clearbit_format | No | When set to any non-empty value, return the Clearbit-compatible response shape. |
hunter_get_v2_discover_peopleHunter — Discover People (GET)Inspect
Discover people matching filters This GET execution profile accepts only natural-language query, limit and offset. Use POST for structured filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of companies to return. Every plan can request up to 100 companies. | |
| query | Yes | Search query, in your natural language. For example, "Companies in Europe in the Tech Industry". | |
| offset | No | Number of companies to skip. Only plans with Discover paging can set an offset above 0. |
hunter_get_v2_domain_finderHunter — Domain Finder (GET)Inspect
Find the domain for a company Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum suggestions to return. | |
| company | Yes | Company name to resolve to a domain. | |
| perfect_match | No | Only return an exact company-name match. |
hunter_get_v2_domain_searchHunter — Domain Search (GET)Inspect
Find email addresses by domain Boolean filters in this execution profile accept canonical true/false only; other provider aliases remain in the original documentation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Get only personal or generic email addresses. | |
| limit | No | Specifies the max number of email addresses to return. The default is 10. | |
| domain | No | Domain name to search. | |
| offset | No | Specifies the number of email addresses to skip. The default is 0. | |
| company | No | Company name to search when the domain is unknown. | |
| seniority | No | Comma-separated seniority values from Hunter's live position taxonomy (not a frozen enum). Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_seniority`). | |
| department | No | Comma-separated department values from Hunter's live position taxonomy (not a frozen enum). `~` matches people with no department. Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_department`). | |
| job_titles | No | Get only email addresses for people that have the selected job title(s). Several job titles can be selected (comma-delimited). Common executive titles match their well-known equivalents, so you don’t have to list every spelling. For example, Chief Technology Officer, Chief Technical Officer, and CTO match each other, and VP matches Vice President (covers CEO, CTO, CFO, COO, CMO, CIO, CISO, CHRO, VP, and HR). Titles match on whole words and common word forms: CTO matches “Co-founder & CTO” but not “Director”, and engineer also finds “Engineering” and “Engineers”. Use job_titles for a specific role wording. To target a whole tier of people (for example, all the leaders at a company), use the seniority, department, and decision_maker filters. | |
| provenance | No | Keep only addresses with this provenance: found, inferred. Replaces `source_type`; when both are sent they must agree, otherwise the request returns 400 (`invalid_provenance`). | |
| saved_leads | No | ||
| source_type | No | Deprecated, use `provenance`. "generated" is the old name for "inferred". | |
| aggregations | No | Set to true or false to include a breakdown of the domain's email addresses in meta.aggregations: the number of personal email addresses per department, the number of decision makers, and the split between personal and generic addresses. The counts reflect the filters applied to the search. Omitted by default. | |
| decision_maker | No | A boolean filter. Query-string clients may use the documented case-insensitive aliases. This execution profile accepts canonical true/false only; see the full native schema for other boolean aliases. | |
| required_field | No | Get only email addresses for people that have the selected field(s). The possible values are full_name, position and phone_number. Several fields can be selected (comma-delimited). | |
| verification_status | No | Get only email addresses that have the selected verification status(es). The possible values are valid, accept_all and unknown. Several statuses can be selected (comma-delimited). |
hunter_get_v2_email_countHunter — Email Count (GET)Inspect
Return aggregate counts without revealing individual email addresses. This operation is free. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Get the count of only personal or generic email addresses. | |
| domain | No | Domain name to count. | |
| company | No | Company name to count when the domain is unknown. | |
| include_job_titles | No | Include job-title counts when set to any non-empty value. An empty value or omission disables it. |
hunter_get_v2_email_finderHunter — Email Finder (GET)Inspect
Supply a LinkedIn handle, or supply a domain/company plus either a full name or first and last name. A found email address is also saved automatically to your leads. This is enabled by default and can be disabled for your account. The saved lead keeps the verification status this response reports. It leaves out a phone number that is on a data broker deletion list, such as California's DROP. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Domain name of the company. A URL or a leading "@" is accepted and reduced to the domain name, so "https://www.example.com/about" and "@example.com" search example.com. | |
| company | No | The company name from which you want to find the email addresses. For example, "stripe". Note that providing the domain name gives better results as it removes the conversion from the company name. If you send a request with both the domain and the company name, the domain name will be used. The company name doesn't need to be in lowercase. | |
| full_name | No | The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase. | |
| last_name | No | The person's last name. It doesn't need to be in lowercase. | |
| first_name | No | The person's first name. It doesn't need to be in lowercase. | |
| max_duration | No | The maximum duration of the request in seconds. Setting a longer duration allows us to refine the results and provide more accurate data. It must range between 3 and 20. The default is 10. | |
| linkedin_handle | No | The handle of the LinkedIn profile for which you to find the email address. |
hunter_get_v2_email_verifierHunter — Email Verifier (GET)Inspect
Check the deliverability of an email address. A valid or accept_all email address is also saved automatically to your leads, and a lead you already have gets the new verification result. This is enabled by default and can be disabled for your account. The saved lead leaves out a phone number that is on a data broker deletion list, such as California's DROP.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | The email address you want to verify. | ||
| domain_metadata | No | Include metadata about the email domain when set to any non-empty value. An empty value or omission disables it. |
hunter_get_v2_people_findHunter — Email Enrichment (GET)Inspect
Enrich a person Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| No | Email address to enrich. | ||
| clearbit_format | No | When set to any non-empty value, return the Clearbit-compatible response shape. | |
| linkedin_handle | No | LinkedIn profile handle to enrich. |
hunter_post_v2_discoverHunter — Discover (POST)Inspect
Find companies matching a structured filter set. This operation is free. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of companies to return. Every plan can request up to 100 companies. | |
| query | No | Search query, in your natural language. For example, "Companies in Europe in the Tech Industry". | |
| offset | No | Number of companies to skip. Only plans with Discover paging can set an offset above 0. | |
| funding | No | You can provide a list of funding series in the series field to narrow down your selection of companies. The possible values are pre_seed, seed, pre_series_a, series_a, pre_series_b, series_b, pre_series_c, series_c+ or other You can also specify a range of funding amounts in the amount field, you can specify a from and/or to value Finally you can also specify a range of funding dates in the date field, here you can also specify a from and/or to value in YYYY-MM-DD format. Both dates are inclusive; omitting a bound leaves that side of the range open. Applied dates, including those resolved from a natural-language query, are returned in meta.filters.funding.date and can be reused for pagination. This filter is only available on a Premium plan. | |
| industry | No | Industry names to include or exclude. | |
| keywords | No | Keywords to narrow down your selection of companies. You can specify a list of keywords in the include field to select on and/or a list in the exclude field to exclude from the results. You can specify to match on any or all keywords in the match field (the default value is all). | |
| headcount | No | The company sizes you want to include in the results. The possible values are 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000 or 10001+. The company size is the range the company reports publicly. We raise it when our data clearly shows a larger company. The emails_count in the results counts the email addresses we found for the domain. It is not the number of employees. | |
| similar_to | No | You can either specify a domain or a name of a company to find similar companies for. If you specify both then the domain will be used. This filter is only available on a Premium plan. | |
| technology | No | Technology slugs to include or exclude. | |
| company_type | No | Hunter company types to include or exclude. | |
| job_openings | No | Filter companies by LinkedIn job openings. Department values come from the jobs-index vocabulary (not a frozen enum). Unknown departments return 400. | |
| organization | No | You can specify a list of domains in the domain field to select on and/or a list of company names in the name field to select on. When you supply both, the API will combine the results into a set of domain names. | |
| year_founded | No | The years in which the companies were founded, for example "2010". You can specify either multiple years to include and/or exclude or you can specify a range by giving a value for from and/or to. This filter is only available on a Premium plan. | |
| headquarters_location | No | Locations of the headquarters of the companies you want to find. You can specify lists of locations in the include field to select on and/or in the exclude field to exclude. Each location can have either a continent or business_region or country, state and/or city. continent can be one of the following: Europe, Asia, North America, Africa, Antarctica, South America or Oceania business_region can be one of the following: AMER, EMEA, APAC or LATAM country must contain a valid ISO 3166-1 alpha-2 country code, for example "US" for the United States. state must contain a valid US state code, for example "CA" for California. You can only use this field when the country is set to "US". city must contain a city name, for example "San Francisco". Please note that when a city is provided, a country must also be specified: { "headquarters_location": { "include": [ { "city": "Paris", "country": "FR" } ] } } |
hunter_post_v2_discover_peopleHunter — Discover People (POST)Inspect
Discover people using request-body filters Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of companies to return. Every plan can request up to 100 companies. | |
| query | No | Search query, in your natural language. For example, "Companies in Europe in the Tech Industry". | |
| offset | No | Number of companies to skip. Only plans with Discover paging can set an offset above 0. | |
| funding | No | ||
| industry | No | Industry names to include or exclude. | |
| keywords | No | ||
| headcount | No | ||
| similar_to | No | ||
| technology | No | Technology slugs to include or exclude. | |
| company_type | No | Hunter company types to include or exclude. | |
| job_openings | No | Filter companies by LinkedIn job openings. Department values come from the jobs-index vocabulary (not a frozen enum). Unknown departments return 400. | |
| organization | No | ||
| year_founded | No | ||
| headquarters_location | No |
hunter_post_v2_domain_searchHunter — Domain Search (POST)Inspect
Use POST for nested location filters. The body can be JSON or URL-encoded form data. Boolean filters in this execution profile accept canonical true/false only; other provider aliases remain in the original documentation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Get only personal or generic email addresses. | |
| limit | No | Specifies the max number of email addresses to return. The default is 10. | |
| domain | No | Domain name from which you want to find the email addresses. For example, "stripe.com". | |
| offset | No | Specifies the number of email addresses to skip. The default is 0. | |
| company | No | The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase. | |
| location | No | Get only email addresses for people with the selected location(s). You can specify lists of locations in the include field to select on and/or in the exclude field to exclude. Each location can have either a continent or business_region or country, state and/or city. continent can be one of the following: Africa, Antarctica, Asia, Europe, North America, Oceania or South America business_region can be one of the following: AMER, EMEA, APAC or LATAM country must contain a valid ISO 3166-1 alpha-2 country code, for example "US" for the United States. state must contain a valid US state code, for example "CA" for California. You can only use this field when the country is set to "US". city must contain a city name, for example "San Francisco". Please note that when a city is provided, a country must also be specified: { "location": { "include": [ { "city": "Paris", "country": "FR" } ] } } Please note that using this filter requires to use a POST request. | |
| seniority | No | Comma-separated seniority values from Hunter's live position taxonomy (not a frozen enum). Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_seniority`). | |
| department | No | Comma-separated department values from Hunter's live position taxonomy (not a frozen enum). `~` matches people with no department. Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_department`). | |
| job_titles | No | Get only email addresses for people that have the selected job title(s). Several job titles can be selected (comma-delimited). Common executive titles match their well-known equivalents, so you don’t have to list every spelling. For example, Chief Technology Officer, Chief Technical Officer, and CTO match each other, and VP matches Vice President (covers CEO, CTO, CFO, COO, CMO, CIO, CISO, CHRO, VP, and HR). Titles match on whole words and common word forms: CTO matches “Co-founder & CTO” but not “Director”, and engineer also finds “Engineering” and “Engineers”. Use job_titles for a specific role wording. To target a whole tier of people (for example, all the leaders at a company), use the seniority, department, and decision_maker filters. | |
| provenance | No | Keep only addresses with this provenance: found, inferred. Replaces `source_type`; when both are sent they must agree, otherwise the request returns 400 (`invalid_provenance`). | |
| saved_leads | No | ||
| source_type | No | Deprecated, use `provenance`. "generated" is the old name for "inferred". | |
| aggregations | No | Set to true or false to include a breakdown of the domain's email addresses in meta.aggregations: the number of personal email addresses per department, the number of decision makers, and the split between personal and generic addresses. The counts reflect the filters applied to the search. Omitted by default. | |
| decision_maker | No | A boolean filter. Query-string clients may use the documented case-insensitive aliases. This execution profile accepts canonical true/false only; see the full native schema for other boolean aliases. | |
| required_field | No | Get only email addresses for people that have the selected field(s). The possible values are full_name, position and phone_number. Several fields can be selected (comma-delimited). | |
| verification_status | No | Get only email addresses that have the selected verification status(es). The possible values are valid, accept_all and unknown. Several statuses can be selected (comma-delimited). |
hunter_post_v2_multi_domain_searchHunter — Multi-Domain Search (POST)Inspect
Search professional email addresses across many companies at once using a structured filter set. Returns masked rows — no email address or phone number; use the reveal endpoint to unmask. This masked survey operation is free. At least one filter is required. Filters may be sent in the request body (JSON or form-encoded) or as query-string parameters; the body is therefore optional. Boolean filters in this execution profile accept canonical true/false only; other provider aliases remain in the original documentation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Comma-separated email types: personal, generic. | |
| limit | No | Number of rows to return per page. | |
| domain | No | Comma-separated domain names, 25 at most. A URL is cleaned to its domain. Hidden and unknown domains are dropped. With two or more remaining domains, the page spreads its rows across them (up to limit divided by the number of domains for each, never more than limit in total) and returns no next_search_after cursor. | |
| industry | No | Comma-separated integer industry codes. | |
| location | No | Comma-separated ISO 3166-1 alpha-2 country codes. | |
| headcount | No | Comma-separated company-size buckets (e.g. 11-50, 51-200). | |
| job_title | No | Comma-separated free-text job titles. A person matches when their position matches any of the titles. Independent of department and seniority. | |
| seniority | No | Comma-separated seniority levels: junior, senior, executive. | |
| department | No | Comma-separated departments (e.g. executive, sales, marketing). | |
| per_domain | No | When true, include a per-domain result breakdown in meta. This execution profile accepts canonical true/false only; see the full native schema for other boolean aliases. | |
| provenance | No | Comma-separated provenance values: found, inferred. | |
| technology | No | Comma-separated technology slugs. | |
| company_name | No | Comma-separated company names. | |
| company_type | No | Comma-separated Hunter company types. | |
| founded_year | No | Comma-separated founding years. | |
| search_after | No | Opaque pagination cursor from meta.next_search_after. Omit for the first page. | |
| decision_maker | No | When true, keep only decision-makers. This execution profile accepts canonical true/false only; see the full native schema for other boolean aliases. | |
| min_confidence | No | Minimum email confidence score. | |
| required_field | No | Comma-separated fields that every returned person must have (AND): full_name, position, phone_number. | |
| verification_status | No | Comma-separated verification statuses: valid, accept_all, unknown. | |
| exclude_already_saved | No | When true, omit people already saved as leads in your account. This refines a search but does not satisfy the at-least-one-filter requirement on its own. This execution profile accepts canonical true/false only; see the full native schema for other boolean aliases. |
hunter_post_v2_multi_domain_search_revealHunter — Multi-Domain Search Reveal (POST)Inspect
Reveal emails from a multi-domain search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handles | Yes | Reveal handles from this team and billing period; maximum 100. |
hyperliquid_post_info_active_asset_dataHyperliquid — Retrieve User's Active Asset DataInspect
Retrieve User's Active Asset Data Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve User's Active Asset Data Documentation prepared only; runtime not verified. |
hyperliquid_post_info_all_borrow_lend_reserve_statesHyperliquid — Query all borrow/lend reserve statesInspect
Query all borrow/lend reserve states Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query all borrow/lend reserve states Documentation prepared only; runtime not verified. |
hyperliquid_post_info_all_midsHyperliquid — Retrieve mids for all coinsInspect
Retrieve mids for all coins Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve mids for all coins Documentation prepared only; runtime not verified. |
hyperliquid_post_info_all_perp_metasHyperliquid — Retrieve all perpetuals metadata (universe and margin tables)Inspect
Retrieve all perpetuals metadata (universe and margin tables) Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve all perpetuals metadata (universe and margin tables) Documentation prepared only; runtime not verified. |
hyperliquid_post_info_approved_buildersHyperliquid — Query approved builders for userInspect
Query approved builders for user Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query approved builders for user Documentation prepared only; runtime not verified. |
hyperliquid_post_info_borrow_lend_reserve_stateHyperliquid — Query borrow/lend reserve stateInspect
Query borrow/lend reserve state Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query borrow/lend reserve state Documentation prepared only; runtime not verified. |
hyperliquid_post_info_borrow_lend_user_stateHyperliquid — Query borrow/lend user stateInspect
Query borrow/lend user state Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query borrow/lend user state Documentation prepared only; runtime not verified. |
hyperliquid_post_info_candle_snapshotHyperliquid — Candle snapshotInspect
Candle snapshot Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Candle snapshot Documentation prepared only; runtime not verified. |
hyperliquid_post_info_clearinghouse_stateHyperliquid — Retrieve user's perpetuals account summaryInspect
Retrieve user's perpetuals account summary Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve user's perpetuals account summary Documentation prepared only; runtime not verified. |
hyperliquid_post_info_delegationsHyperliquid — Query a user's staking delegationsInspect
Query a user's staking delegations Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's staking delegations Documentation prepared only; runtime not verified. |
hyperliquid_post_info_delegator_historyHyperliquid — Query a user's staking historyInspect
Query a user's staking history Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's staking history Documentation prepared only; runtime not verified. |
hyperliquid_post_info_delegator_rewardsHyperliquid — Query a user's staking rewardsInspect
Query a user's staking rewards Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's staking rewards Documentation prepared only; runtime not verified. |
hyperliquid_post_info_delegator_summaryHyperliquid — Query a user's staking summaryInspect
Query a user's staking summary Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's staking summary Documentation prepared only; runtime not verified. |
hyperliquid_post_info_frontend_open_ordersHyperliquid — Retrieve a user's open orders with additional frontend infoInspect
Retrieve a user's open orders with additional frontend info Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's open orders with additional frontend info Documentation prepared only; runtime not verified. |
hyperliquid_post_info_funding_historyHyperliquid — Retrieve historical funding ratesInspect
Retrieve historical funding rates Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical funding rates Documentation prepared only; runtime not verified. |
hyperliquid_post_info_historical_ordersHyperliquid — Retrieve a user's historical ordersInspect
Retrieve a user's historical orders Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's historical orders Documentation prepared only; runtime not verified. |
hyperliquid_post_info_l2_bookHyperliquid — L2 book snapshotInspect
L2 book snapshot Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | L2 book snapshot Documentation prepared only; runtime not verified. |
hyperliquid_post_info_max_builder_feeHyperliquid — Check builder fee approvalInspect
Check builder fee approval Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Check builder fee approval Documentation prepared only; runtime not verified. |
hyperliquid_post_info_metaHyperliquid — Retrieve perpetuals metadata (universe and margin tables)Inspect
Retrieve perpetuals metadata (universe and margin tables) Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve perpetuals metadata (universe and margin tables) Documentation prepared only; runtime not verified. |
hyperliquid_post_info_meta_and_asset_ctxsHyperliquid — Retrieve perpetuals asset contexts (includes mark price, current funding, open interest, etc.)Inspect
Retrieve perpetuals asset contexts (includes mark price, current funding, open interest, etc.) Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve perpetuals asset contexts (includes mark price, current funding, open interest, etc.) Documentation prepared only; runtime not verified. |
hyperliquid_post_info_open_ordersHyperliquid — Retrieve a user's open ordersInspect
Retrieve a user's open orders Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's open orders Documentation prepared only; runtime not verified. |
hyperliquid_post_info_order_statusHyperliquid — Query order status by oid or cloidInspect
Query order status by oid or cloid Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query order status by oid or cloid Documentation prepared only; runtime not verified. |
hyperliquid_post_info_outcome_deployer_limitsHyperliquid — Retrieve outcome deployer limitsInspect
Retrieve outcome deployer limits Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve outcome deployer limits Documentation prepared only; runtime not verified. |
hyperliquid_post_info_outcome_metaHyperliquid — Retrieve outcome metadataInspect
Retrieve outcome metadata Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve outcome metadata Documentation prepared only; runtime not verified. |
hyperliquid_post_info_outcome_templatesHyperliquid — Retrieve outcome templatesInspect
Retrieve outcome templates Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve outcome templates Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perp_annotationHyperliquid — Retrieve perp annotationInspect
Retrieve perp annotation Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve perp annotation Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perp_categoriesHyperliquid — Retrieve perp categoriesInspect
Retrieve perp categories Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve perp categories Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perp_concise_annotationsHyperliquid — Retrieve concise perp annotationsInspect
Retrieve concise perp annotations Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve concise perp annotations Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perp_deploy_auction_statusHyperliquid — Retrieve information about the Perp Deploy AuctionInspect
Retrieve information about the Perp Deploy Auction Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve information about the Perp Deploy Auction Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perp_dex_limitsHyperliquid — Retrieve Builder-Deployed Perp Market LimitsInspect
Retrieve Builder-Deployed Perp Market Limits Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve Builder-Deployed Perp Market Limits Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perp_dexsHyperliquid — Retrieve all perpetual dexsInspect
Retrieve all perpetual dexs Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve all perpetual dexs Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perp_dex_statusHyperliquid — Get Perp Market StatusInspect
Get Perp Market Status Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Perp Market Status Documentation prepared only; runtime not verified. |
hyperliquid_post_info_perps_at_open_interest_capHyperliquid — Query perps at open interest capsInspect
Query perps at open interest caps Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query perps at open interest caps Documentation prepared only; runtime not verified. |
hyperliquid_post_info_portfolioHyperliquid — Query a user's portfolioInspect
Query a user's portfolio Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's portfolio Documentation prepared only; runtime not verified. |
hyperliquid_post_info_predicted_fundingsHyperliquid — Retrieve predicted funding rates for different venuesInspect
Retrieve predicted funding rates for different venues Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve predicted funding rates for different venues Documentation prepared only; runtime not verified. |
hyperliquid_post_info_referralHyperliquid — Query a user's referral informationInspect
Query a user's referral information Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's referral information Documentation prepared only; runtime not verified. |
hyperliquid_post_info_settled_outcomeHyperliquid — Retrieve information about a settled outcomeInspect
Retrieve information about a settled outcome Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve information about a settled outcome Documentation prepared only; runtime not verified. |
hyperliquid_post_info_spot_clearinghouse_stateHyperliquid — Retrieve a user's token balancesInspect
Retrieve a user's token balances Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's token balances Documentation prepared only; runtime not verified. |
hyperliquid_post_info_spot_deploy_stateHyperliquid — Retrieve information about the Spot Deploy AuctionInspect
Retrieve information about the Spot Deploy Auction Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve information about the Spot Deploy Auction Documentation prepared only; runtime not verified. |
hyperliquid_post_info_spot_metaHyperliquid — Retrieve spot metadataInspect
Retrieve spot metadata Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve spot metadata Documentation prepared only; runtime not verified. |
hyperliquid_post_info_spot_meta_and_asset_ctxsHyperliquid — Retrieve spot asset contextsInspect
Retrieve spot asset contexts Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve spot asset contexts Documentation prepared only; runtime not verified. |
hyperliquid_post_info_spot_pair_deploy_auction_statusHyperliquid — Retrieve information about the Spot Pair Deploy AuctionInspect
Retrieve information about the Spot Pair Deploy Auction Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve information about the Spot Pair Deploy Auction Documentation prepared only; runtime not verified. |
hyperliquid_post_info_sub_accountsHyperliquid — Retrieve a user's subaccountsInspect
Retrieve a user's subaccounts Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's subaccounts Documentation prepared only; runtime not verified. |
hyperliquid_post_info_token_detailsHyperliquid — Retrieve information about a tokenInspect
Retrieve information about a token Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve information about a token Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_abstractionHyperliquid — Query a user's abstraction stateInspect
Query a user's abstraction state Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's abstraction state Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_dex_abstractionHyperliquid — Query a user's HIP-3 DEX abstraction stateInspect
Query a user's HIP-3 DEX abstraction state Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's HIP-3 DEX abstraction state Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_feesHyperliquid — Query a user's feesInspect
Query a user's fees Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's fees Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_fillsHyperliquid — Retrieve a user's fillsInspect
Retrieve a user's fills Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's fills Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_fills_by_timeHyperliquid — Retrieve a user's fills by timeInspect
Retrieve a user's fills by time Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's fills by time Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_fundingHyperliquid — Retrieve a user's funding history or non-funding ledger updates — userFundingInspect
Retrieve a user's funding history or non-funding ledger updates Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's funding history or non-funding ledger updates Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_non_funding_ledger_updatesHyperliquid — Retrieve a user's funding history or non-funding ledger updates — userNonFundingLedgerUpdatesInspect
Retrieve a user's funding history or non-funding ledger updates Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's funding history or non-funding ledger updates Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_rate_limitHyperliquid — Query user rate limitsInspect
Query user rate limits Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query user rate limits Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_roleHyperliquid — Query a user's roleInspect
Query a user's role Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query a user's role Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_twap_slice_fillsHyperliquid — Retrieve a user's TWAP slice fillsInspect
Retrieve a user's TWAP slice fills Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's TWAP slice fills Documentation prepared only; runtime not verified. |
hyperliquid_post_info_user_vault_equitiesHyperliquid — Retrieve a user's vault depositsInspect
Retrieve a user's vault deposits Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a user's vault deposits Documentation prepared only; runtime not verified. |
hyperliquid_post_info_vault_detailsHyperliquid — Retrieve details for a vaultInspect
Retrieve details for a vault Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve details for a vault Documentation prepared only; runtime not verified. |
jupiter_delete_prediction_v1_positions_positionpubkeyJupiter — Prediction API — Prepare unsigned close positionInspect
Build an unsigned transaction that sells every contract of one position before the market resolves. Sign it and submit it to POST /execute together with the execution.context object. This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Close position — complete JSON body for the verified unsigned preparation profile. | |
| positionPubkey | Yes | Position account public key |
jupiter_get_lend_v1_borrow_positionsJupiter — Lend Borrow — List borrow positions for usersInspect
Returns borrow positions (NFTs) for one or more wallet addresses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| users | Yes | Comma-separated Solana wallet addresses. | |
| market | No | Lend market identifier. Defaults to `main`. |
jupiter_get_lend_v1_borrow_vaultsJupiter — Lend Borrow — List borrow vaultsInspect
Returns all whitelisted borrow vaults for the requested market. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| market | No | Lend market identifier. Defaults to `main`. |
jupiter_get_lend_v1_earn_earningsJupiter — Lend Earn — earningsInspect
Request for the earnings of one or multiple positions of a user Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | User wallet address | |
| positions | Yes | User token positions (comma-separated) |
jupiter_get_lend_v1_earn_positionsJupiter — Lend Earn — positionsInspect
Request for the position data of one or multiple users Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| users | Yes | User wallet addresses (comma separated) |
jupiter_get_lend_v1_earn_tokensJupiter — Lend Earn — tokensInspect
Request for the tokens available to be deposited and their information Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
jupiter_get_prediction_v1_eventsJupiter — Prediction API — List eventsInspect
Paginated list of prediction events, each holding one or more binary YES/NO markets. Filter by provider, category, subcategory, tags and status (filter), sort by volume or start time, and set includeMarkets=true to nest each event's markets in the response. Paginate with the start and end indexes. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Pagination end index of the page to return. | |
| tags | No | Filter events by tag (e.g. `soccer`). | |
| start | No | Pagination start index of the page to return. | |
| filter | No | Apply named filters. Use `new` for events created in the last 24 hours, `live` for events that have begun, `trending` for events with recent trade activity, and `upcoming` for events that have not begun yet. | |
| sortBy | No | Sort field for events (volume or begin time). Pair with sortDirection to control ascending/descending. | |
| category | No | Event category. `all` returns every category. | |
| provider | No | Data provider for events (defaults to polymarket). Use `bisonfi` for Jupiter Forecast markets. | |
| subcategory | No | Subcategory within the chosen category. Import profile accepts the string branch only; other union branches are not exposed. | |
| sortDirection | No | Direction for the chosen sort field. Defaults to desc for volume and asc for beginAt. | |
| includeMarkets | No | Set to `true` to nest each event's markets in the response. | |
| includeAllMarkets | No | Include all allowed sports market types (moneyline, spread, totals) and extra (e.g. Saba) markets mapped onto Polymarket events. Defaults to false (moneyline only). F1 events always include every sportsMarketType. |
jupiter_get_prediction_v1_events_eventid_marketsJupiter — Prediction API — List event marketsInspect
Paginated list of the binary markets of an event. Each market is a YES/NO question with its own id, status, pricing and result. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Pagination end index of the page to return. | |
| start | No | Pagination start index of the page to return. | |
| eventId | Yes | Event identifier |
jupiter_get_prediction_v1_events_eventid_markets_marketidJupiter — Prediction API — Get event marketInspect
One market scoped to its event: title, status, result, open and close times, resolution time, rules and outcomes with current pricing. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| eventId | Yes | Event identifier | |
| marketId | Yes | Market identifier |
jupiter_get_prediction_v1_events_eventid_scoreJupiter — Prediction API — Get event scoreInspect
Latest live score for one sports event: teams, score, period, elapsed time and status. Returns null when the event has no score. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| eventId | Yes | Event identifier |
jupiter_get_prediction_v1_historyJupiter — Prediction API — Get historyInspect
Paginated history of order, fill, settlement and claim events. Filter by ownerPubkey or positionPubkey, or pass id to fetch a single event. Paginate with start and end. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | History event ID | |
| end | No | Pagination end index of the page to return. | |
| start | No | Pagination start index of the page to return. | |
| ownerPubkey | Yes | History owner public key Required by the captured native runtime despite being optional in the published OpenAPI. | |
| positionPubkey | No | Filter by position public key |
jupiter_get_prediction_v1_leaderboardsJupiter — Prediction API — Get leaderboardsInspect
Ranked traders for a period and metric: P&L, volume or win rate. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of entries to return. | |
| metric | No | Ranking metric: `pnl`, `volume` or `win_rate`. | |
| period | No | Ranking window: `all_time`, `weekly` or `monthly`. |
jupiter_get_prediction_v1_markets_marketidJupiter — Prediction API — Get marketInspect
One market by id: title, status, result, open and close times, resolution time, rules and outcomes with current pricing. Prices are in micro USD (1,000,000 = $1). Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| marketId | Yes | Market identifier |
jupiter_get_prediction_v1_orderbook_marketidJupiter — Prediction API — Get orderbookInspect
Current orderbook depth for a market: YES and NO levels in contracts and in dollars. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| marketId | Yes | Kalshi or Polymarket market identifier |
jupiter_get_prediction_v1_ordersJupiter — Prediction API — List ordersInspect
Paginated list of orders registered onchain. Filter by ownerPubkey and paginate with start and end. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Pagination end index of the page to return. | |
| start | No | Pagination start index of the page to return. | |
| ownerPubkey | Yes | Filter orders by owner wallet public key. Required by the captured native runtime despite being optional in the published OpenAPI. |
jupiter_get_prediction_v1_orders_orderpubkeyJupiter — Prediction API — Get orderInspect
One order by its account public key: market, side, size, status and timestamps. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| orderPubkey | Yes | Order account public key |
jupiter_get_prediction_v1_orders_status_orderpubkeyJupiter — Prediction API — Get order statusInspect
Latest status of an order with its event history. Poll it after POST /execute to follow the fill. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| orderPubkey | Yes | Order account public key |
jupiter_get_prediction_v1_positionsJupiter — Prediction API — List positionsInspect
Paginated list of onchain positions, each holding YES or NO contracts in one market. Filter by ownerPubkey, marketPubkey, marketId and isYes; paginate with start and end. USD values are in micro USD (1,000,000 = $1). Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Pagination end index of the page to return. | |
| isYes | No | Filter by position side (true = YES, false = NO) | |
| start | No | Pagination start index of the page to return. | |
| marketId | No | Filter by market id. | |
| ownerPubkey | Yes | Position owner public key Required by the captured native runtime despite being optional in the published OpenAPI. | |
| marketPubkey | No | Filter by market account public key. |
jupiter_get_prediction_v1_positions_positionpubkeyJupiter — Prediction API — Get positionInspect
One position by its account public key: side, contracts held (contractsMicro and contractsDecimal), cost basis, mark price and unrealised P&L in micro USD. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| positionPubkey | Yes | Position account public key |
jupiter_get_prediction_v1_profiles_ownerpubkeyJupiter — Prediction API — Get profileInspect
Trading statistics of a wallet: realised P&L, volume, prediction counts, active contracts and portfolio value. USD values are in micro USD. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ownerPubkey | Yes | Wallet public key. |
jupiter_get_prediction_v1_tradesJupiter — Prediction API — Get trade feedInspect
Recent fills (order_filled events) across the exchange. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
jupiter_get_prediction_v1_trading_statusJupiter — Prediction API — Get trading statusInspect
Whether the exchange currently accepts orders (trading_active). Check it before building an order. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
jupiter_get_prediction_v1_vault_infoJupiter — Prediction API — Get vault infoInspect
Settlement vault account: public key, decoded account data and balance. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
jupiter_get_price_v3Jupiter — Price API V3 — priceInspect
Get USD prices for up to 50 tokens per request. Tokens without a reliable price are omitted from the response. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | Comma separate to pass in multiple |
jupiter_get_query_prediction_jupiter_prediction_api_get_event_79Jupiter — Prediction API — Get eventInspect
One event by id, with its category, tags, metadata, volume and live score. Set includeMarkets=true to nest its markets. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| eventId | Yes | Event identifier | |
| includeMarkets | No | Set to `true` to nest the event's markets in the response. | |
| includeAllMarkets | No | Include all allowed sports market types (moneyline, spread, totals) and extra (e.g. Saba) markets mapped onto Polymarket events. Defaults to false (moneyline only). F1 events always include every sportsMarketType. |
jupiter_get_query_prediction_jupiter_prediction_api_get_live_scoJupiter — Prediction API — Get live scoresInspect
Latest live scores for several sports events in one call. Pass the event ids as a comma-separated eventIds list; events without a score are omitted from the response. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| eventIds | Yes | Comma-separated event IDs to fetch live scores for (max 100) |
jupiter_get_query_prediction_jupiter_prediction_api_search_eventJupiter — Prediction API — Search eventsInspect
Full-text search of prediction events by title. Returns the matching events with pagination. Use provider=bisonfi for Jupiter Forecast markets. Latest request and response verified through OpenAny testnet.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of events to return, 1 to 20. | |
| query | Yes | Search term matched against event titles | |
| provider | No | Data provider for events (defaults to polymarket). Use `bisonfi` for Jupiter Forecast markets. |
jupiter_get_send_v1_invite_historyJupiter — Send API — invite-historyInspect
Request for the invite history of an address Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | - Pagination of response | |
| address | Yes | - Pubkey can be sender or recipient |
jupiter_get_send_v1_pending_invitesJupiter — Send API — pending-invitesInspect
Request for the pending invites of an address Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | - Pagination of response | |
| address | Yes | - Pubkey of Sender |
jupiter_get_swap_v2_buildJupiter — Swap API V2 — Prepare unsigned build TransactionInspect
Get a swap quote with raw instructions for building custom transactions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Quoting mode. "fast" trades quote optimality for reduced latency. | |
| dexes | No | - Comma-separated list of DEXes to restrict routing to. - Labels are case sensitive (`SolFi`, not `solfi`). An unrecognised label is not a validation error: it returns `400 {"error": "No routes found"}`, indistinguishable from a pair with no liquidity. - Mutually exclusive with excludeDexes. Passing both returns `400 {"error": "dexes and excludeDexes are mutually exclusive"}`. - Full list of DEXes here using the `/program-id-to-label` endpoint. | |
| payer | No | Account that pays transaction fees and rent. Defaults to taker when not passed in. | |
| taker | Yes | Public key of the user initiating the swap. | |
| amount | Yes | The amount to swap in the smallest unit of the input token | |
| inputMint | Yes | The mint address of the input token | |
| tipAmount | No | SOL tip amount in lamports. Adds a tip instruction for use with /submit. The tip payer is the taker (or payer if specified). | |
| feeAccount | No | Token account to collect platform fees. Required if platformFeeBps is positive. | |
| outputMint | Yes | The mint address of the output token | |
| maxAccounts | No | Maximum number of accounts for the swap route. Defaults to 64. | |
| slippageBps | No | Slippage tolerance in basis points. Defaults to 50. Import profile accepts the string branch only; other union branches are not exposed. | |
| excludeDexes | No | - Comma-separated list of DEXes to exclude. - Labels are case sensitive (`SolFi`, not `solfi`). - Mutually exclusive with dexes. - Full list of DEXes here using the `/program-id-to-label` endpoint. | |
| forJitoBundle | No | Set to `true` if the transaction will be submitted as part of a Jito bundle. This excludes DEXes that are incompatible with Jito bundles. | |
| platformFeeBps | No | Platform fee in basis points. If positive, feeAccount is required. | |
| wrapAndUnwrapSol | No | Whether to wrap/unwrap SOL. Defaults to true. | |
| transactionVersion | No | The Solana transaction version to build for, `"0"` or `"1"`. Defaults to `"0"`. `"1"` returns v1 instructions: `computeBudgetInstructions` is empty and `addressesByLookupTableAddress` is `{}` (v1 inlines accounts, no lookup tables). Set the compute budget, including the returned `computeUnitPrice`, on the message config. Build with a v1-capable SDK (`@solana/kit` v8 or later). | |
| blockhashSlotsToExpiry | No | Number of slots until the blockhash expires. Defaults to 150. | |
| destinationTokenAccount | No | - SPL token account to receive output tokens. - Mutually exclusive with nativeDestinationAccount. | |
| nativeDestinationAccount | No | - Native SOL account to receive output. - Mutually exclusive with destinationTokenAccount. | |
| computeUnitPricePercentile | No | Percentile of compute unit price to use. Named levels: "medium" (25th), "high" (50th), "veryHigh" (75th), or a number 0-10000 in basis points. Import profile accepts the string branch only; other union branches are not exposed. |
jupiter_get_swap_v2_orderJupiter — Swap API V2 — Get a swap quoteInspect
Get a swap quote and assembled transaction. This is the default happy path with all Ultra benefits Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| payer | No | - The public key of an account that will cover gas-related fees (signature fees, priority fees, and rent) on behalf of the taker - Has no effect when set equal to `taker`. Must be a different wallet to activate integrator-sponsored gas - Disables Dflow and OKX routing. Metis and JupiterZ RFQ still compete - On JupiterZ routes the market maker pays signature and priority fees, and `payer` only pays rent for the output token accounts the transaction creates. When the output is native SOL there are none, so `payer` is not a signer - Sign with `payer` only if it is a required signer of the returned transaction | |
| taker | No | - The public key of the wallet that will sign the transaction - If not provided, the response will contain a quote but no transaction - Must be present if you intend to sign and execute the transaction via `/execute` | |
| amount | Yes | The amount to swap in the smallest unit of the input token | |
| receiver | No | - The public key of the account that will receive the output tokens - Must differ from `taker` - Expects a wallet address, not a token account - For non-SOL output: tokens are sent to the receiver's associated token account (ATA). If the ATA is not initialised, a create ATA instruction is added to the transaction - For SOL output: native SOL is transferred directly to the receiver - Does not support destination wSOL token accounts - Disables Dflow and OKX routing. Metis and JupiterZ RFQ still compete | |
| swapMode | No | - Swap mode. Currently only `ExactIn` is supported. | |
| inputMint | Yes | The mint address of the input token | |
| outputMint | Yes | The mint address of the output token | |
| referralFee | No | - Referral fee in basis points (50-255) - Must be used together with `referralAccount` | |
| slippageBps | No | - Slippage tolerance in basis points (0-10000) - If not set, Jupiter automatically determines an appropriate slippage | |
| excludeDexes | No | - Comma-separated list of DEXes to exclude from the Metis router - **Important**: This only affects the Metis router, not other routers - For example: `excludeDexes=Raydium,Orca+V2,Meteora+DLMM` - Labels are case sensitive (`SolFi`, not `solfi`). Full list of DEXes here using the `/program-id-to-label` endpoint. - On `/order` only `excludeDexes` is honoured, not `dexes`. Use `/build` to restrict routing to specific DEXes. | |
| excludeRouters | No | - Comma-separated list of routers to exclude - Available routers: `metis`, `jupiterz`, `dflow`, `okx` | |
| jitoTipLamports | No | - Jito MEV tip in lamports for faster block inclusion | |
| referralAccount | No | - Address of your referral account for the Jupiter referral project - Must be used together with `referralFee` - See the [Referral Program](/tool-kits/referral-program) for setup | |
| broadcastFeeType | No | - Fee cap strategy: `maxCap` treats the fee as a maximum, `exactFee` uses the exact amount - Ignored if neither `priorityFeeLamports` nor `jitoTipLamports` are set | |
| priorityFeeLamports | No | - Priority fee in lamports - If not set, Jupiter automatically determines an appropriate priority fee - Setting this overrides the automatic optimisation | |
| maxSupportedTransactionVersion | No | - The highest Solana transaction version your client can accept, `"0"` or `"1"`. Defaults to `"0"`. - This is a ceiling, not a force. You get v1 only when Metis wins the route and the order is not gasless; other routers and gasless orders (including automatic sponsorship for low-SOL takers) return v0. Wider v1 support is in progress. - Read the response `transactionVersion` to see the version you got. v1 transactions must be deserialized and signed with a v1-capable SDK (`@solana/kit` v8 or later). |
jupiter_get_swap_v2_program_id_to_labelJupiter — Swap API V2 — Program ID to LabelInspect
Returns a hash, which key is the program id and value is the label. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
jupiter_get_tokens_v2_category_intervalJupiter — Tokens API V2 — categoryInspect
Returns an array of mints and their information for the given category and interval Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | - Maximum number of results to return (default 50, max 100) | |
| category | Yes | - Top tokens in different trading categories - The result filters out generic top tokens like SOL, USDC, etc - Default to 50 mints in response | |
| interval | Yes | - Query by time interval for more accuracy |
jupiter_get_tokens_v2_recentJupiter — Tokens API V2 — recentInspect
Returns an array of mints that recently had their first created pool Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
jupiter_get_tokens_v2_searchJupiter — Tokens API V2 — searchInspect
Request a search by token's symbol, name or mint address Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | - Search for a token and its information by its symbol, name or mint address - Comma-separate to ONLY search for multiple mint addresses - Limit to 100 mint addresses in query - Default to 20 mints in response when searching via symbol or name |
jupiter_get_tokens_v2_tagJupiter — Tokens API V2 — tagInspect
Request an array of mints and their information by a tag Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Native query parameter. Preserve provider-returned identifiers and the documented JSON type. |
jupiter_get_tokens_v2_verify_express_check_eligibilityJupiter — Token Verification — Check express verification eligibilityInspect
Checks whether a token is eligible for express verification and metadata updates. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tokenId | Yes | Token mint address to check eligibility for |
jupiter_post_lend_v1_borrow_operateJupiter — Lend Borrow — Prepare unsigned build unsigned operate transactionInspect
Builds a base64-encoded unsigned versioned transaction for a borrow operate action. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Build unsigned operate transaction — complete JSON body for the verified unsigned preparation profile. | |
| market | No | Lend market identifier. Defaults to `main`. |
jupiter_post_lend_v1_borrow_operate_instructionsJupiter — Lend Borrow — Prepare unsigned build operate instructionsInspect
Returns Solana instructions and lookup table addresses for a borrow operate action. This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Build operate instructions — complete JSON body for the verified unsigned preparation profile. | |
| market | No | Lend market identifier. Defaults to `main`. |
jupiter_post_lend_v1_earn_depositJupiter — Lend Earn — Prepare unsigned depositInspect
Request for a base64-encoded unsigned earn deposit transaction to deposit assets This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | deposit — complete JSON body for the verified unsigned preparation profile. |
jupiter_post_lend_v1_earn_deposit_instructionsJupiter — Lend Earn — Prepare unsigned deposit-instructionsInspect
Request for the instruction of an earn deposit transaction to deposit assets This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | deposit-instructions — complete JSON body for the verified unsigned preparation profile. |
jupiter_post_lend_v1_earn_mintJupiter — Lend Earn — Prepare unsigned mintInspect
Request for a base64-encoded unsigned earn mint transaction to mint shares This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | mint — complete JSON body for the verified unsigned preparation profile. |
jupiter_post_lend_v1_earn_mint_instructionsJupiter — Lend Earn — Prepare unsigned mint-instructionsInspect
Request for the instruction of an earn mint transaction to mint shares This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | mint-instructions — complete JSON body for the verified unsigned preparation profile. |
jupiter_post_lend_v1_earn_redeemJupiter — Lend Earn — Prepare unsigned redeemInspect
Request for a base64-encoded unsigned earn redeem transaction to redeem shares This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | redeem — complete JSON body for the verified unsigned preparation profile. |
jupiter_post_lend_v1_earn_redeem_instructionsJupiter — Lend Earn — Prepare unsigned redeem-instructionsInspect
Request for the instruction of an earn redeem transaction to redeem shares This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | redeem-instructions — complete JSON body for the verified unsigned preparation profile. |
jupiter_post_lend_v1_earn_withdrawJupiter — Lend Earn — Prepare unsigned withdrawInspect
Request for a base64-encoded unsigned earn withdraw transaction to withdraw assets This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | withdraw — complete JSON body for the verified unsigned preparation profile. |
jupiter_post_lend_v1_earn_withdraw_instructionsJupiter — Lend Earn — Prepare unsigned withdraw-instructionsInspect
Request for the instruction of an earn withdraw transaction to withdraw assets This is an unsigned preparation/quote operation; no transaction was signed, submitted or executed in verification. Latest request and response verified through OpenAny testnet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | withdraw-instructions — complete JSON body for the verified unsigned preparation profile. |
justoneapi_get_api_1688_get_category_info_v11688 Category Information API (V1)Inspect
Retrieves 1688 category information by category ID, or root categories when no ID is supplied. Use it to navigate categories during product sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| catId | No | 1688 platform category ID. |
justoneapi_get_api_1688_get_category_item_list_v11688 Category Products API (V1)Inspect
Retrieves 1688 products by platform category ID with pagination and optional sourcing filters. Use it to discover products within a known category. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| catId | Yes | 1688 platform category ID. | |
| freeShipping | No | Filter for free shipping. | |
| isSuperFactory | No | Optional super-factory filter. | |
| supportDropshipping | No | Filter for support for dropshipping. |
justoneapi_get_api_1688_get_category_item_list_v21688 Category Products API (V2)Inspect
Retrieves 1688 products by category ID with output language, pagination, sorting and price filters. Use it to discover category products for multilingual sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| sort | No | Product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending | |
| catId | Yes | 1688 platform category ID. | |
| language | No | Output language. Available Values: - `en`: English - `zh`: Chinese - `ru`: Russian - `vi`: Vietnamese - `ja`: Japanese - `ko`: Korean | |
| pageSize | No | Number of items requested per page. The returned count may differ. | |
| priceEnd | No | Maximum price filter in CNY. | |
| newArrival | No | Filter for new products. | |
| priceStart | No | Minimum price filter in CNY. | |
| freeShipping | No | Filter for free shipping. | |
| isSuperFactory | No | Optional super-factory filter. | |
| supportDropshipping | No | Filter for support for dropshipping. |
justoneapi_get_api_1688_get_item_description_images_v11688 Product Description Images API (V1)Inspect
Retrieves 1688 product description images by item ID. Use it to review listing descriptions during catalog preparation and product research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | 1688 product ID. |
justoneapi_get_api_1688_get_item_detail_by_url_v11688 Product Details [URL] API (V1)Inspect
Retrieves 1688 product details by product URL with an optional output language. Use it to inspect a known listing during sourcing and catalog research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 1688 product URL. | |
| scene | No | Optional dropshipping pricing scene. Available Values: - `drop_shipping`: Dropshipping | |
| language | No | Output language. Available Values: - `en`: English - `zh`: Chinese - `ru`: Russian - `th`: Thai - `pt`: Portuguese - `es`: Spanish - `tr`: Turkish - `vi`: Vietnamese - `ja`: Japanese - `ko`: Korean | |
| optimizeTitle | No | Optimize Chinese titles by removing non-core words. |
justoneapi_get_api_1688_get_item_detail_v11688 Product Details API (V1)Inspect
Retrieves the public product detail for a 1688 wholesale listing by item ID. Use it to review a known offer during product sourcing or catalog research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | A unique product identifier on 1688. |
justoneapi_get_api_1688_get_item_detail_v21688 Product Details API (V2)Inspect
Retrieves 1688 product details by item ID with an optional output language and dropshipping scene. Use it to inspect a known product during sourcing and catalog research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| scene | No | Optional dropshipping pricing scene. Available Values: - `drop_shipping`: Dropshipping | |
| itemId | Yes | 1688 product ID. | |
| language | No | Output language. Available Values: - `en`: English - `zh`: Chinese - `ru`: Russian - `th`: Thai - `pt`: Portuguese - `es`: Spanish - `tr`: Turkish - `vi`: Vietnamese - `ja`: Japanese - `ko`: Korean | |
| optimizeTitle | No | Optimize Chinese titles by removing non-core words. |
justoneapi_get_api_1688_get_item_rating_list_v11688 Product Reviews API (V1)Inspect
Retrieves 1688 product reviews by item ID with pagination and default or latest sorting. Use it to review buyer feedback during product sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| itemId | Yes | 1688 product ID. | |
| sortType | No | Review sort order. Available Values: - `default`: Default order - `latest`: Latest reviews first |
justoneapi_get_api_1688_get_item_shipping_v11688 Product Shipping Fee API (V1)Inspect
Retrieves a 1688 product shipping estimate for a Chinese province using quantity and optional total weight. Use it to estimate domestic procurement shipping costs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | 1688 product ID. | |
| province | Yes | Chinese province name or abbreviation, for example Guangdong or gd. | |
| totalWeight | No | Total shipment weight in kilograms. | |
| totalQuantity | No | Total number of items to ship. |
justoneapi_get_api_1688_get_shop_category_v11688 Shop Categories API (V1)Inspect
Retrieves all categories for a 1688 shop by shop URL or seller member ID. Use it to navigate a shop catalog during product sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| shopUrl | No | 1688 shop homepage URL. Supply shopUrl or memberId. | |
| memberId | No | Seller member ID. Supply memberId or shopUrl. |
justoneapi_get_api_1688_get_shop_info_v11688 Shop Information API (V1)Inspect
Retrieves 1688 shop information by shop URL or seller member ID. Use it to research a known shop during procurement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| shopUrl | No | 1688 shop homepage URL. Supply shopUrl or memberId. | |
| memberId | No | Seller member ID. Supply memberId or shopUrl. |
justoneapi_get_api_1688_get_shop_item_list_by_url_v11688 Shop Products [URL] API (V1)Inspect
Retrieves 1688 shop products by shop homepage URL with pagination, sorting and optional category filters. Use it to research a shop product catalog. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cat | No | Optional category ID filter. | |
| page | No | Page number, starting at 1. | |
| sort | No | Shop product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending - `time_up`: Time ascending - `time_down`: Time descending | |
| catType | No | Optional category mode: 0 or 1. Available Values: - `0`: Category mode 0 - `1`: Category mode 1 | |
| shopUrl | Yes | 1688 shop homepage URL. | |
| pageSize | No | Number of items requested per page. The returned count may differ. |
justoneapi_get_api_1688_get_shop_item_list_v11688 Shop Products [ID] API (V1)Inspect
Retrieves 1688 shop products by seller member ID with pagination, sorting and optional category and price filters. Use it to research a shop product catalog. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| sort | No | Shop product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending - `time_up`: Time ascending - `time_down`: Time descending | |
| memberId | Yes | Seller member ID. | |
| pageSize | No | Number of items requested per page. The returned count may differ. | |
| priceEnd | No | Maximum price filter in CNY. | |
| shopCatId | No | Shop category ID. | |
| priceStart | No | Minimum price filter in CNY. |
justoneapi_get_api_1688_search_cross_border_item_by_image_v11688 Cross-border Image Search API (V1)Inspect
Searches 1688 cross-border products by image with language selection, pagination, sorting and sourcing filters. Use it to find products for multilingual visual sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| sort | No | Product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending | |
| imgUrl | Yes | Image URL or image reference returned by Image Conversion. Convert external images for the selected search target before searching. | |
| language | No | Output language. Available Values: - `en`: English - `zh`: Chinese - `ru`: Russian - `th`: Thai - `pt`: Portuguese - `es`: Spanish - `tr`: Turkish - `vi`: Vietnamese - `ja`: Japanese - `ko`: Korean | |
| pageSize | No | Number of items requested per page. The returned count may differ. | |
| priceEnd | No | Maximum price filter in CNY. | |
| isFactory | No | Filter by factory status. | |
| newArrival | No | Filter for new products. | |
| priceStart | No | Minimum price filter in CNY. | |
| freeShipping | No | Filter for free shipping. | |
| verifiedSupplier | No | Filter for verified sellers. | |
| supportDropshipping | No | Filter for support for dropshipping. |
justoneapi_get_api_1688_search_cross_border_item_by_image_v21688 Cross-border Image Search API (V2)Inspect
Searches 1688 cross-border products by image with language selection, pagination, sorting and sourcing filters. Use it to find products for multilingual visual sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| sort | No | Product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending | |
| imgUrl | Yes | Image reference returned by Image Conversion with searchApiEndpoint=cross_border_v2. Convert full image URLs before searching. | |
| language | No | Output language. Available Values: - `en`: English - `zh`: Chinese - `ru`: Russian - `vi`: Vietnamese - `ja`: Japanese - `ko`: Korean | |
| pageSize | No | Number of items requested per page. The returned count may differ. | |
| priceEnd | No | Maximum price filter in CNY. | |
| isFactory | No | Filter by factory status. | |
| newArrival | No | Filter for new products. | |
| priceStart | No | Minimum price filter in CNY. | |
| freeShipping | No | Filter for free shipping. | |
| verifiedSupplier | No | Filter for verified sellers. | |
| supportDropshipping | No | Filter for support for dropshipping. |
justoneapi_get_api_1688_search_cross_border_item_list_v11688 Cross-border Product Search API (V1)Inspect
Searches 1688 cross-border products by keyword or category with language selection, pagination and sourcing filters. Use it to discover products for multilingual procurement. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| sort | No | Product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending | |
| catId | No | 1688 category ID. Supply catId or keyword. | |
| keyword | No | Search keyword. Supply keyword or catId. | |
| language | No | Output language. Available Values: - `en`: English - `zh`: Chinese - `ru`: Russian - `vi`: Vietnamese - `ja`: Japanese - `ko`: Korean | |
| pageSize | No | Number of items requested per page. The returned count may differ. | |
| priceEnd | No | Maximum price filter in CNY. | |
| newArrival | No | Filter for new products. | |
| priceStart | No | Minimum price filter in CNY. | |
| freeShipping | No | Filter for free shipping. | |
| isSuperFactory | No | Optional super-factory filter. | |
| supportDropshipping | No | Filter for support for dropshipping. |
justoneapi_get_api_1688_search_factory_v11688 Factory Search API (V1)Inspect
Searches 1688 factories by keyword with pagination and default or repurchase-rate sorting. Use it to discover manufacturers during procurement research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. | |
| sort | No | Factory sort order. Available Values: - `default`: Default order - `repurchase_rate`: Repurchase-rate order | |
| keyword | Yes | Factory search keyword. | |
| pageSize | No | Number of items requested per page. The returned count may differ. |
justoneapi_get_api_1688_search_item_by_image_v11688 Product Search by Image API (V1)Inspect
Searches 1688 products by image with pagination, sorting and optional sourcing filters. Use it to find matching products during visual sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| moq | No | Minimum order quantity filter. | |
| page | No | Page number, starting at 1. | |
| sort | No | Product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending | |
| imgUrl | Yes | Image URL or image reference returned by Image Conversion. Convert external images for the selected search target before searching. | |
| pageSize | No | Number of items requested per page. The returned count may differ. | |
| priceEnd | No | Maximum price filter in CNY. | |
| isFactory | No | Filter by factory status. | |
| newArrival | No | Filter for new products. | |
| priceStart | No | Minimum price filter in CNY. | |
| freeShipping | No | Filter for free shipping. | |
| verifiedSupplier | No | Filter for verified sellers. | |
| supportDropshipping | No | Filter for support for dropshipping. |
justoneapi_get_api_1688_search_item_list_v11688 Product Search API (V1)Inspect
Searches 1688 wholesale product listings by keyword. Use it to discover candidate products or suppliers during sourcing and market research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Search keyword. |
justoneapi_get_api_1688_search_item_list_v21688 Product Search API (V2)Inspect
Searches 1688 products by keyword with pagination, sorting, price ranges and optional sourcing filters. Use it to discover products during procurement and market research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| moq | No | Minimum order quantity filter. | |
| page | No | Page number, starting at 1. | |
| sort | No | Product sort order. Available Values: - `default`: Default order - `sales`: Sales order - `price_up`: Price ascending - `price_down`: Price descending | |
| keyword | Yes | Search keyword. | |
| pageSize | No | Number of items requested per page. The returned count may differ. | |
| priceEnd | No | Maximum price filter in CNY. | |
| newArrival | No | Filter for new products. | |
| priceStart | No | Minimum price filter in CNY. | |
| freeShipping | No | Filter for free shipping. | |
| isSuperFactory | No | Optional super-factory filter. | |
| supportDropshipping | No | Filter for support for dropshipping. |
justoneapi_get_api_aliexpress_get_product_detail_v1AliExpress Product Overview API (V1)Inspect
Retrieves an AliExpress product overview by item ID for the United States or global site. Use it to inspect a known listing for catalog review or search snippets. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | No | AliExpress site: US (default) or GLO (global). Available Values: - `GLO`: Global site - `US`: United States site | |
| itemId | Yes | Numeric AliExpress item ID. |
justoneapi_get_api_aliexpress_search_products_v1AliExpress Product Search API (V1)Inspect
Searches AliExpress products with optional query, page, sort, category, brand, location, attribute, price, locale, region, and currency controls. Use it for product discovery, catalog research, and marketplace assortment analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Product search query. | |
| loc | No | Location filter for product search results. | |
| attr | No | Product attribute filter for search results. | |
| page | No | One-based page number for pagination. | |
| sort | No | Sort order for product search results. Available Values: - `default`: Default result order - `salesDesc`: Sales volume, highest first - `priceAsc`: Price, lowest first - `priceDesc`: Price, highest first | |
| catId | No | Category ID used to filter product search results. | |
| locale | No | Locale used for the AliExpress response. | |
| region | No | AliExpress marketplace region. | |
| brandId | No | Brand ID used to filter product search results. | |
| currency | No | Currency code used for product prices. | |
| endPrice | No | Maximum product price filter, inclusive. | |
| switches | No | Search switches used to select optional result features. | |
| startPrice | No | Minimum product price filter, inclusive. |
justoneapi_get_api_amazon_get_best_sellers_v1Amazon Best Sellers API (V1)Inspect
Retrieves paginated Amazon Best Sellers for a category path in a selected country marketplace. Use it to study category leaders, discover popular products, or compare bestseller pages across marketplaces. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| country | No | Country code for the Amazon product. Available Values: - `US`: United States - `AU`: Australia - `BR`: Brazil - `CA`: Canada - `CN`: China - `FR`: France - `DE`: Germany - `IN`: India - `IT`: Italy - `MX`: Mexico - `NL`: Netherlands - `SG`: Singapore - `ES`: Spain - `TR`: Turkey - `AE`: United Arab Emirates - `GB`: United Kingdom - `JP`: Japan - `SA`: Saudi Arabia - `PL`: Poland - `SE`: Sweden - `BE`: Belgium - `EG`: Egypt - `ZA`: South Africa - `IE`: Ireland | |
| category | Yes | Best Sellers category path taken from an Amazon Best Sellers URL. It may be a category slug or a nested category path. |
justoneapi_get_api_amazon_get_category_products_v1Amazon Products By Category API (V1)Inspect
Retrieves paginated Amazon products for a numeric category node in a selected country marketplace, with configurable result sorting. Use it to browse a category, compare assortments, or collect category-specific product candidates. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sortBy | No | Sort by. Available Values: - `RELEVANCE`: Relevance - `LOWEST_PRICE`: Lowest Price - `HIGHEST_PRICE`: Highest Price - `REVIEWS`: Reviews - `NEWEST`: Newest - `BEST_SELLERS`: Best Sellers | |
| country | No | Country code for the Amazon product. Available Values: - `US`: United States - `AU`: Australia - `BR`: Brazil - `CA`: Canada - `CN`: China - `FR`: France - `DE`: Germany - `IN`: India - `IT`: Italy - `MX`: Mexico - `NL`: Netherlands - `SG`: Singapore - `ES`: Spain - `TR`: Turkey - `AE`: United Arab Emirates - `GB`: United Kingdom - `JP`: Japan - `SA`: Saudi Arabia - `PL`: Poland - `SE`: Sweden - `BE`: Belgium - `EG`: Egypt - `ZA`: South Africa - `IE`: Ireland | |
| categoryId | Yes | Numeric Amazon category node ID taken from the node query parameter of a category URL. |
justoneapi_get_api_amazon_get_product_detail_v1Amazon Product Details API (V1)Inspect
Retrieves details for an Amazon product identified by ASIN in a selected country marketplace. Use it to look up a known listing for catalog review, product comparison, or downstream commerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| asin | Yes | ASIN (Amazon Standard Identification Number). | |
| country | No | Country code for the Amazon product. Available Values: - `US`: United States - `AU`: Australia - `BR`: Brazil - `CA`: Canada - `CN`: China - `FR`: France - `DE`: Germany - `IN`: India - `IT`: Italy - `MX`: Mexico - `NL`: Netherlands - `SG`: Singapore - `ES`: Spain - `TR`: Turkey - `AE`: United Arab Emirates - `GB`: United Kingdom - `JP`: Japan - `SA`: Saudi Arabia - `PL`: Poland - `SE`: Sweden - `BE`: Belgium - `EG`: Egypt - `ZA`: South Africa - `IE`: Ireland |
justoneapi_get_api_amazon_get_product_top_reviews_v1Amazon Product Top Reviews API (V1)Inspect
Retrieves the top reviews for an Amazon product identified by ASIN in a selected country marketplace. Use it to review prominent customer feedback for product research, sentiment analysis, or quality assessment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| asin | Yes | ASIN (Amazon Standard Identification Number). | |
| country | No | Country code for the Amazon product. Available Values: - `US`: United States - `AU`: Australia - `BR`: Brazil - `CA`: Canada - `CN`: China - `FR`: France - `DE`: Germany - `IN`: India - `IT`: Italy - `MX`: Mexico - `NL`: Netherlands - `SG`: Singapore - `ES`: Spain - `TR`: Turkey - `AE`: United Arab Emirates - `GB`: United Kingdom - `JP`: Japan - `SA`: Saudi Arabia - `PL`: Poland - `SE`: Sweden - `BE`: Belgium - `EG`: Egypt - `ZA`: South Africa - `IE`: Ireland |
justoneapi_get_api_amazon_search_products_v1Amazon Product Search API (V1)Inspect
Searches Amazon marketplace products by keyword or ASIN with country, sort, condition, Prime-only, deals, and page controls. Use it to discover products for catalog research, price comparison, or competitive assortment analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sortBy | No | Sort order for Amazon product search results. Available Values: - `RELEVANCE`: Relevance - `LOWEST_PRICE`: Lowest Price - `HIGHEST_PRICE`: Highest Price - `REVIEWS`: Reviews - `NEWEST`: Newest - `BEST_SELLERS`: Best Sellers | |
| country | No | Country code for the Amazon marketplace. Available Values: - `US`: United States - `AU`: Australia - `BR`: Brazil - `CA`: Canada - `CN`: China - `FR`: France - `DE`: Germany - `IN`: India - `IT`: Italy - `MX`: Mexico - `NL`: Netherlands - `SG`: Singapore - `ES`: Spain - `TR`: Turkey - `AE`: United Arab Emirates - `GB`: United Kingdom - `JP`: Japan - `SA`: Saudi Arabia - `PL`: Poland - `SE`: Sweden - `BE`: Belgium - `EG`: Egypt - `ZA`: South Africa - `IE`: Ireland | |
| isPrime | No | Whether to return only Prime-eligible products. | |
| keyword | Yes | Search keyword or ASIN to find Amazon products. | |
| productCondition | No | Product condition filter for Amazon search results. Available Values: - `ALL`: All product conditions - `NEW`: New products - `USED`: Used products - `RENEWED`: Renewed products - `COLLECTIBLE`: Collectible products | |
| dealsAndDiscounts | No | Deals and discounts filter for Amazon search results. Available Values: - `NONE`: Do not filter by deals or discounts - `ALL_DISCOUNTS`: Return discounted products - `TODAYS_DEALS`: Return today's deals |
justoneapi_get_api_bilibili_get_user_detail_v2Bilibili User Profile API (V2)Inspect
Retrieves a Bilibili user profile identified by UID. Use it to look up a known account for creator research, profile review, or subsequent retrieval of that user's videos. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Bilibili User ID (UID). |
justoneapi_get_api_bilibili_get_user_relation_stat_v1Bilibili User Relation Stats API (V1)Inspect
Retrieves relation statistics for a Bilibili user identified by WMID. Use it to compare audience relationships across creator accounts or track relation-count changes for a known user. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| wmid | Yes | Bilibili User ID (WMID). |
justoneapi_get_api_bilibili_get_user_video_list_v2Bilibili User Published Videos API (V2)Inspect
Retrieves videos published by a Bilibili user identified by UID, with an optional continuation parameter from a prior response. Use it to browse a creator's uploads or continue through their video list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Bilibili User ID (UID). | |
| param | No | Pagination parameter from previous response. |
justoneapi_get_api_bilibili_get_video_caption_v2Bilibili Video Captions API (V2)Inspect
Retrieves caption data for a Bilibili video segment identified by BVID, AID, and CID. Use it to obtain subtitles for transcript extraction, accessibility review, or language-focused content analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aid | Yes | Bilibili AID. | |
| cid | Yes | Bilibili CID. | |
| bvid | Yes | Bilibili Video ID (BVID). |
justoneapi_get_api_bilibili_get_video_comment_v2Bilibili Video Comments API (V2)Inspect
Retrieves comments for a Bilibili video identified by AID, with optional cursor pagination. Use it to review audience discussion, continue through comment pages, or support comment moderation and analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aid | Yes | Bilibili Archive ID (AID). | |
| cursor | No | Pagination cursor. |
justoneapi_get_api_bilibili_get_video_danmu_v2Bilibili Video Danmaku API (V2)Inspect
Retrieves one page of danmaku comments for a Bilibili video segment identified by AID and CID. Use it to review time-synchronized audience reactions or page through danmaku for a known video. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aid | Yes | Bilibili Archive ID (AID). | |
| cid | Yes | Bilibili Chat ID (CID). | |
| page | No | Page number for pagination. |
justoneapi_get_api_bilibili_get_video_detail_v2Bilibili Video Details API (V2)Inspect
Retrieves details for a Bilibili video identified by its BVID. Use it to look up a known video for content review, cataloging, or subsequent engagement analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bvid | Yes | Bilibili Video ID (BVID). |
justoneapi_get_api_bilibili_search_video_v2Bilibili Video Search API (V2)Inspect
Searches Bilibili videos by keyword with page-based pagination and sorting by general ranking, play count, publish time, danmaku count, or favorites. Use it to support content discovery, topic research, or ranking-focused searches. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| order | No | Sorting criteria for search results. Available Values: - `general`: General - `click`: Most Played - `pubdate`: Latest - `dm`: Most Danmaku - `stow`: Most Favorite | |
| keyword | Yes | Search keyword. |
justoneapi_get_api_douban_get_movie_comments_v1Douban Movie Comments API (V1)Inspect
Retrieves paginated Douban short comments for a movie or TV subject, ordered by time or newest rating. Use it to review concise audience feedback for a known subject. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Sort order for the result set. Available Values: - `time`: Time - `new_score`: New Score | |
| subjectId | Yes | The unique ID for a movie or TV subject on Douban. |
justoneapi_get_api_douban_get_movie_review_detail_v1Douban Movie Review Details API (V1)Inspect
Retrieves a single Douban long-form review by its review ID. Use it to inspect a known review after discovering it in a subject's review list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| reviewId | Yes | The unique ID for a specific review on Douban. |
justoneapi_get_api_douban_get_movie_reviews_v1Douban Movie Movie Reviews API (V1)Inspect
Retrieves paginated Douban long-form reviews for a movie or TV subject, ordered by time or popularity. Use it to browse in-depth audience reviews for a known subject. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Sort order for the result set. Available Values: - `time`: Time - `hotest`: Hotest | |
| subjectId | Yes | The unique ID for a movie or TV subject on Douban. |
justoneapi_get_api_douban_get_recent_hot_movie_v1Douban Movie Recent Hot Movie API (V1)Inspect
Retrieves a paginated list of movies currently featured in Douban's recent-hot collection. Use it to discover popular movie titles and continue through result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. |
justoneapi_get_api_douban_get_recent_hot_tv_v1Douban Movie Recent Hot Tv API (V1)Inspect
Retrieves a paginated list of TV titles currently featured in Douban's recent-hot collection. Use it to discover popular series and continue through result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. |
justoneapi_get_api_douban_get_subject_detail_v1Douban Movie Subject Details API (V1)Inspect
Retrieves the public detail page data for a Douban movie or TV subject by subject ID. Use it to inspect a known title before requesting its reviews or comments. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| subjectId | Yes | The unique ID for a movie or TV subject on Douban. |
justoneapi_get_api_douyin_ec_get_item_comments_v1Douyin E-commerce Item Comments API (V1)Inspect
Retrieves paginated customer comments for a Douyin E-commerce product by item ID. Use it to review product feedback for a known marketplace item. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for paginated comments. | |
| itemId | Yes | The unique ID of the item on Douyin E-commerce. |
justoneapi_get_api_douyin_ec_get_item_detail_v2Douyin E-commerce Item Details API (V2)Inspect
Retrieves Douyin E-commerce product details by item ID. Use it to inspect a known marketplace item for catalog or product research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | The unique ID of the item on Douyin E-commerce. |
justoneapi_get_api_douyin_ec_get_item_sku_info_v1Douyin E-commerce Product SKU Info API (V1)Inspect
Retrieves SKU information for a Douyin E-commerce product by item ID. Use it to inspect the purchasable variations of a known product during catalog review. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | The unique ID of the item on Douyin E-commerce. |
justoneapi_get_api_douyin_ec_get_item_sku_info_v2Douyin E-commerce Product SKU Info API (V2)Inspect
Retrieves SKU information for a Douyin E-commerce product by item ID. Returns code 202 when the product is not supported. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | The unique ID of the item on Douyin E-commerce. |
justoneapi_get_api_douyin_ec_get_shop_item_list_v1Douyin E-commerce Shop Product List API (V1)Inspect
Retrieves a paginated product list for a Douyin E-commerce shop by shop ID. Use it to browse a known seller's marketplace catalog page by page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| shopId | Yes | The unique ID of the shop on Douyin E-commerce. |
justoneapi_get_api_douyin_ec_search_item_list_v1Douyin E-commerce Product Search API (V1)Inspect
Searches Douyin E-commerce products by keyword with page and search-ID pagination. Use it to discover marketplace products and continue a multi-page search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| keyword | Yes | Search keyword. | |
| searchId | No | Search ID; use the search_id value returned by the last response for subsequent pages. |
justoneapi_get_api_douyin_get_user_detail_v3Douyin (TikTok China) User Profile API (V3)Inspect
Retrieves a Douyin (TikTok China) user profile by secUid. Use it to review a known creator or account before monitoring related content or conducting account research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| secUid | Yes | The unique user ID (sec_uid) on Douyin. |
justoneapi_get_api_douyin_get_user_video_list_v1Douyin (TikTok China) User Published Videos API (V1)Inspect
Retrieves videos published by a Douyin (TikTok China) user, with cursor pagination and newest or most-popular sorting. Use it to browse or monitor a creator's public video output. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| secUid | Yes | The unique user ID (sec_user_id) on Douyin. | |
| sortType | No | Sort order: `LATEST` for newest first (default), or `MOST_POPULAR` for most popular first. Available Values: - `LATEST`: Newest first (default) - `MOST_POPULAR`: Most popular first | |
| maxCursor | No | Pagination cursor; use 0 for the first page, and the `max_cursor` from the previous response for subsequent pages. |
justoneapi_get_api_douyin_get_user_video_list_v3Douyin (TikTok China) User Published Videos API (V3)Inspect
Retrieves videos published by a Douyin (TikTok China) user with cursor pagination. Use it to browse a known creator's public video history or continue through video pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| secUid | Yes | The unique user ID (sec_uid) on Douyin. | |
| maxCursor | No | Pagination cursor; use 0 for the first page, and the `max_cursor` from the previous response for subsequent pages. |
justoneapi_get_api_douyin_get_video_comment_v1Douyin (TikTok China) Video Comments API (V1)Inspect
Retrieves top-level comments for a Douyin (TikTok China) video by aweme ID with page-based pagination. Use it to review audience feedback or analyze discussion around a known video. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (starting from 1). | |
| awemeId | Yes | The unique video identifier (aweme_id). |
justoneapi_get_api_douyin_get_video_detail_v2Douyin (TikTok China) Video Details API (V2)Inspect
Retrieves details for a Douyin (TikTok China) video by video ID. Use it to look up a known video before content review, archiving, or related analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| videoId | Yes | The unique video identifier (aweme_id or model_id). |
justoneapi_get_api_douyin_get_video_sub_comment_v1Douyin (TikTok China) Comment Replies API (V1)Inspect
Retrieves replies to a top-level Douyin (TikTok China) video comment with page-based pagination. Use it to inspect threaded discussions and review feedback under a known comment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (starting from 1). | |
| commentId | Yes | The unique identifier of the top-level comment. |
justoneapi_get_api_douyin_hot_search_v1Douyin (TikTok China) Hot Search API (V1)Inspect
Searches Douyin (TikTok China) content with optional keyword, category, video-type, ranking, pagination, engagement, and creator-follower filters. Use it to support trend discovery and campaign research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (starting from 1). Page size is fixed at 10. | |
| keyword | No | Optional search keyword. | |
| sortType | No | Sorting criteria for hot content results. Available Values: - `COMPREHENSIVE`: Comprehensive ranking. - `HIGH_INTERACTION`: Highest interaction count. - `HIGH_LIKE`: Highest like count. - `HIGH_COMMENT`: Highest comment count. - `HIGH_SHARE`: Highest share count. | |
| videoType | No | Video type filter. Available Values: - `ALL`: All video types. - `XINGTU_VIDEO`: Xingtu commercial videos. - `NATURAL_VIDEO`: Natural videos. | |
| contentType | No | Top-level content type. Only one content type can be selected. Available Values: - `ALL`: All content types. - `FASHION`: Fashion. - `TECHNOLOGY`: Technology. - `SCIENCE`: Science. - `PHOTOGRAPHY`: Photography and videography. - `FOOD`: Food. - `MOTHER_BABY`: Mother and baby. - `PARENTING`: Parenting. - `DRAMA`: Drama. - `GAME`: Game. - `AUTOMOTIVE`: Automotive. - `ANIMAL`: Animal. - `TRAVEL`: Travel. - `DANCE`: Dance. - `TRADITIONAL_CULTURE`: Traditional culture. - `ART`: Art. - `SPORTS`: Sports. - `MUSIC`: Music. - `LIFE_RECORD`: Life records. - `HOME_LIVING`: Home and living. - `LEISURE_ENTERTAINMENT`: Leisure entertainment. - `WORKPLACE`: Workplace. - `AGRICULTURE`: Agriculture. - `CASUAL`: Casual videos. - `ACG`: Animation, comics, and games. - `MOVIE`: Movie. - `TV_SERIES`: TV series. - `VARIETY_SHOW`: Variety show. - `CELEBRITY`: Celebrity. - `HUMANITIES_SOCIAL_SCIENCE`: Humanities and social science. - `EDUCATION_CAMPUS`: Education and campus. - `EMOTION`: Emotion. - `FINANCE`: Finance. - `PUBLIC_WELFARE`: Public welfare. | |
| likeCountMax | No | Maximum raw like count. | |
| likeCountMin | No | Minimum raw like count. | |
| shareCountMax | No | Maximum raw share count. | |
| shareCountMin | No | Minimum raw share count. | |
| commentCountMax | No | Maximum raw comment count. | |
| commentCountMin | No | Minimum raw comment count. | |
| followerCountMax | No | Maximum raw creator follower count. | |
| followerCountMin | No | Minimum raw creator follower count. | |
| interactionCountMax | No | Maximum raw interaction count. | |
| interactionCountMin | No | Minimum raw interaction count. |
justoneapi_get_api_douyin_search_image_v1Douyin (TikTok China) Image Post Search API (V1)Inspect
Searches Douyin (TikTok China) image posts by keyword with search-session pagination. Omit searchId for the first page, then use the search ID from the previous response to continue. Use it for visual-content discovery and topic research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | The search keyword. | |
| searchId | No | Search ID returned by the previous response. Leave it empty for the first page. |
justoneapi_get_api_douyin_search_user_v2Douyin (TikTok China) User Search API (V2)Inspect
Searches Douyin (TikTok China) users by keyword with page-based pagination and optional account-type filtering. Use it to discover creators, brands, or verified accounts for research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (starting from 1). | |
| keyword | Yes | The search keyword. | |
| userType | No | Filter by user type. Available Values: - `common_user`: Common User - `enterprise_user`: Enterprise User - `personal_user`: Verified Individual User |
justoneapi_get_api_douyin_search_video_v4Douyin (TikTok China) Video Search API (V4)Inspect
Searches Douyin (TikTok China) videos by keyword with sort, publish-time, duration, and page filters; later pages require the previous search ID. Use it to support content discovery and trend research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (starting from 1). | |
| keyword | Yes | The search keyword. | |
| duration | No | Filter by video duration. Available Values: - `_0`: No Limit - `_1`: Under 1 Minute - `_2`: 1-5 Minutes - `_3`: Over 5 Minutes | |
| searchId | No | Search ID; required for pages > 1. Use data.business_config.next_page.search_id from the previous response, and stop paging when data.business_config.has_more is 0. | |
| sortType | No | Sorting criteria for search results. Available Values: - `_0`: General - `_1`: More likes - `_2`: Newest | |
| publishTime | No | Filter by video publish time range. Available Values: - `_0`: No Limit - `_1`: Last 24 Hours - `_7`: Last 7 Days - `_180`: Last 6 Months |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_2Douyin Creator Marketplace (Xingtu) Creator Contract Base Info APIInspect
Returns Douyin Creator Marketplace (Xingtu) contract-related baseline information for a creator over a selectable 30- or 90-day period. Use it to review creator contract context during campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| range | No | Time range. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_3Douyin Creator Marketplace (Xingtu) Live Statistics API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) live-stream statistics for a creator, with live-room, period, marketplace-order, and flow filters. Use it to compare live-streaming creators for campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | Live data time period. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| flowType | No | Flow type filter. Available Values: - `EXCLUDE`: Exclude - `INCLUDE`: Include | |
| liveType | No | Live room type filter. Available Values: - `ALL`: All live rooms - `GAME`: Game live rooms - `ECOMMERCE`: E-commerce live rooms - `OTHER`: Other live rooms | |
| oAuthorId | Yes | Author's unique ID. | |
| onlyStarOrder | No | Whether to include only Xingtu marketplace orders. |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_4Douyin Creator Marketplace (Xingtu) Commerce Seeding Base Info API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) commerce-seeding baseline information for a creator over a selectable 30- or 90-day period. Use it to research creators for product-seeding campaigns. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| range | No | Time range. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_coDouyin Creator Marketplace (Xingtu) Creator Commerce Spread Info API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) commerce spread information for a specified creator. Use it to compare creators during commerce campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_hoDouyin Creator Marketplace (Xingtu) Creator Homepage Videos API (V1)Inspect
Lists a Douyin Creator Marketplace (Xingtu) creator's homepage videos with keyword, video-type, assignment, date, and page filters. Use it to review relevant content before campaign selection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting from 1. | |
| endDate | No | End publish date in yyyyMMdd format. The filter ends at 23:59:59 in Asia/Shanghai. | |
| keyword | No | Keyword used to search creator homepage videos. | |
| oAuthorId | Yes | Author's unique Xingtu ID. | |
| startDate | No | Start publish date in yyyyMMdd format. The filter starts at 00:00:00 in Asia/Shanghai. | |
| videoType | No | Homepage video type filter. Available Values: - `ALL`: All videos - `PERSONAL`: Personal videos - `XINGTU`: Xingtu videos | |
| onlyAssign | No | Whether to include only assigned videos. Xingtu usually shows this option when `videoType` is `XINGTU`. |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_liDouyin Creator Marketplace (Xingtu) Live Watch Distribution API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) live audience or follower watch-distribution data for a creator and selected live-room type. Use it to assess live audience fit for a campaign. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| liveType | No | Live room type filter. Available Values: - `ALL`: All live rooms - `GAME`: Game live rooms - `ECOMMERCE`: E-commerce live rooms - `OTHER`: Other live rooms | |
| oAuthorId | Yes | Author's unique ID. | |
| liveCrowdType | No | Live audience profile type. Available Values: - `AUDIENCE`: Viewer profile - `FANS`: Follower profile |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_orDouyin Creator Marketplace (Xingtu) Creator Order Experience API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) creator order-experience information for the last 30 or 90 days. Use it to review marketplace order history during creator evaluation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | Time period. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_siDouyin Creator Marketplace (Xingtu) Creator Side Base Info API (V1)Inspect
Returns the Douyin Creator Marketplace (Xingtu) side-card baseline information for a specified creator. Use it to review a creator's marketplace overview during shortlisting. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_taDouyin Creator Marketplace (Xingtu) Creator Tags API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) tags for a specified creator. Use it to classify creators and compare their fit for campaign briefs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| starAuthorId | Yes | Creator's unique Xingtu ID. |
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_base_iDouyin Creator Marketplace (Xingtu) Creator Profile API (V1)Inspect
Returns the Douyin Creator Marketplace (Xingtu) profile for a specified creator and content channel. Use it to review creator information before shortlisting or campaign outreach. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_marketDouyin Creator Marketplace (Xingtu) Marketing Metrics API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) marketing information for a specified creator and content channel. Use it to compare creator commercial offerings during campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_platfoDouyin Creator Marketplace (Xingtu) Creator Channel Metrics API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) channel information for a specified creator and content format. Use it to compare a creator's short-video, live, image-text, or short-drama presence. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_show_iDouyin Creator Marketplace (Xingtu) Showcase Items API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) showcase items for a creator, with content-channel, assignment, and flow filters. Use it to review a creator's marketplace showcase during commerce campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| flowType | No | Flow type filter. Available Values: - `EXCLUDE`: Exclude - `INCLUDE`: Include | |
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. | |
| onlyAssign | No | Whether to only include assigned items. |
justoneapi_get_api_douyin_xingtu_gw_api_data_get_author_hot_commDouyin Creator Marketplace (Xingtu) Comment Keyword Analysis API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) comment keyword analysis for a specified creator. Use it to identify recurring audience discussion themes during creator research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_audienceDouyin Creator Marketplace (Xingtu) Audience Distribution API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) audience-distribution data for a creator, content channel, and selected relationship stage. Use it to assess audience fit for campaign targeting. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| linkType | No | Link type filter. Available Values: - `CONNECTED`: Connected - `AWARE`: Aware - `INTERESTED`: Interested - `LIKE`: Like - `FOLLOW`: Follow | |
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_cp_info_vDouyin Creator Marketplace (Xingtu) Cost Performance Analysis API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) cost-performance information for a specified creator and content channel. Use it to compare creator efficiency during campaign budgeting. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_link_struDouyin Creator Marketplace (Xingtu) Creator Link Structure API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) creator-link structure data for a specified creator and content channel. Use it to compare creator link structures during performance research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_rec_videoDouyin Creator Marketplace (Xingtu) Recommended Videos API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) recommended videos for a specified creator and content channel. Use it to inspect representative content during creator research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_touch_disDouyin Creator Marketplace (Xingtu) Audience Touchpoint Distribution API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) audience-touchpoint distribution data for a specified creator and content channel. Use it to compare audience-contact patterns during campaign research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_video_disDouyin Creator Marketplace (Xingtu) Video Distribution API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) video-distribution data for a specified creator and content channel. Use it to analyze how the creator's videos are distributed during campaign research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_check_author_disDouyin Creator Marketplace (Xingtu) Creator Visibility Status API (V1)Inspect
Returns whether a specified creator can be displayed in Douyin Creator Marketplace (Xingtu) for the selected content channel. Use it to check creator availability before building a campaign shortlist. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_con_2Douyin Creator Marketplace (Xingtu) Conversion Analysis API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) conversion analysis for a creator, content channel, and 30- or 90-day period. Use it to compare creator conversion performance during commerce campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| range | No | Time range. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_conveDouyin Creator Marketplace (Xingtu) Conversion Resources API (V1)Inspect
Lists Douyin Creator Marketplace (Xingtu) conversion-related videos or products for a creator, with industry, period, resource-type, and page filters. Use it to review commerce examples before creator selection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. | |
| range | No | Time range. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. | |
| detailType | No | Resource type. Available Values: - `VIDEO`: Video - `PRODUCT`: Product | |
| industryId | No | Industry category. Available Values: - `ALL`: All - `ELECTRONICS_AND_APPLIANCES`: Electronics and Appliances - `SHOPPING`: Shopping - `FOOD_AND_BEVERAGE`: Food and Beverage - `CLOTHING_AND_ACCESSORIES`: Clothing and Accessories - `HEALTHCARE_AND_MEDICAL`: Healthcare and Medical - `MEDICAL_INSTITUTIONS`: Medical Institutions - `HOME_AND_BUILDING_MATERIALS`: Home and Building Materials - `LOCAL_SERVICES`: Local Services - `BUSINESS_SERVICES`: Business Services - `CULTURE_SPORTS_ENTERTAINMENT`: Leisure and Entertainment - `BEAUTY_SERVICES`: Beauty Services - `REAL_ESTATE`: Real Estate - `EDUCATION_AND_TRAINING`: Education and Training - `TRAVEL_AND_TOURISM`: Travel and Tourism - `PUBLIC_SERVICES`: Public Services - `GAMES`: Games - `RETAIL`: Internet E-commerce Services - `TRANSPORTATION_EQUIPMENT`: Transportation Equipment - `AUTOMOTIVE`: Automotive - `AGRICULTURE_FORESTRY_FISHERY`: Agriculture Forestry Fishery - `CHEMICAL_AND_ENERGY`: Chemical and Energy - `ELECTRONICS_AND_ELECTRICAL`: Electronics and Electrical - `MACHINERY_EQUIPMENT`: Machinery Equipment - `MEDIA_AND_INFORMATION`: Media and Information - `LOGISTICS`: Logistics - `TELECOMMUNICATIONS`: Telecommunications - `FINANCIAL_SERVICES`: Financial Services - `CATERING_SERVICES`: Catering Services - `SOFTWARE_TOOLS`: Software Tools - `FRANCHISING_AND_INVESTMENT`: Franchising and Investment - `BEAUTY_AND_COSMETICS`: Beauty and Cosmetics - `MOTHER_BABY_AND_PET`: Mother Baby and Pet - `DAILY_CHEMICALS`: Daily Chemicals - `PHYSICAL_BOOKS`: Physical Books - `SOCIAL_AND_COMMUNICATION`: Social and Communication - `CULTURAL_SUPPLIES`: Cultural Supplies - `SPORTS_OUTDOOR`: Sports and Outdoors |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_dailyDouyin Creator Marketplace (Xingtu) Follower Growth Trend API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) daily follower trend data for a specified creator and date range. Use it to review follower growth patterns during creator evaluation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| endDate | Yes | End Date (yyyy-MM-dd). | |
| oAuthorId | Yes | Author's unique ID. | |
| startDate | Yes | Start Date (yyyy-MM-dd). |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_fansDouyin Creator Marketplace (Xingtu) Follower Distribution API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) follower or loyal-follower distribution data for a specified creator. Use it to compare audience-profile distributions during creator selection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| oAuthorId | Yes | Author's unique ID. | |
| authorType | No | Author type filter. Available Values: - `FAN`: Fan - `DIE_HARD_FAN`: Die Hard Fan |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_linkDouyin Creator Marketplace (Xingtu) Creator Link Metrics API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) creator-link metrics for a specified creator, content channel, and industry category. Use it to review creator link information in an industry context. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. | |
| industryTag | No | Industry tag. Available Values: - `ALL`: All - `ELECTRONICS_AND_APPLIANCES`: Electronics and Appliances - `SHOPPING`: Shopping - `FOOD_AND_BEVERAGE`: Food and Beverage - `CLOTHING_AND_ACCESSORIES`: Clothing and Accessories - `HEALTHCARE_AND_MEDICAL`: Healthcare and Medical - `MEDICAL_INSTITUTIONS`: Medical Institutions - `HOME_AND_BUILDING_MATERIALS`: Home and Building Materials - `LOCAL_SERVICES`: Local Services - `BUSINESS_SERVICES`: Business Services - `CULTURE_SPORTS_ENTERTAINMENT`: Leisure and Entertainment - `BEAUTY_SERVICES`: Beauty Services - `REAL_ESTATE`: Real Estate - `EDUCATION_AND_TRAINING`: Education and Training - `TRAVEL_AND_TOURISM`: Travel and Tourism - `PUBLIC_SERVICES`: Public Services - `GAMES`: Games - `RETAIL`: Internet E-commerce Services - `TRANSPORTATION_EQUIPMENT`: Transportation Equipment - `AUTOMOTIVE`: Automotive - `AGRICULTURE_FORESTRY_FISHERY`: Agriculture Forestry Fishery - `CHEMICAL_AND_ENERGY`: Chemical and Energy - `ELECTRONICS_AND_ELECTRICAL`: Electronics and Electrical - `MACHINERY_EQUIPMENT`: Machinery Equipment - `MEDIA_AND_INFORMATION`: Media and Information - `LOGISTICS`: Logistics - `TELECOMMUNICATIONS`: Telecommunications - `FINANCIAL_SERVICES`: Financial Services - `CATERING_SERVICES`: Catering Services - `SOFTWARE_TOOLS`: Software Tools - `FRANCHISING_AND_INVESTMENT`: Franchising and Investment - `BEAUTY_AND_COSMETICS`: Beauty and Cosmetics - `MOTHER_BABY_AND_PET`: Mother Baby and Pet - `DAILY_CHEMICALS`: Daily Chemicals - `PHYSICAL_BOOKS`: Physical Books - `SOCIAL_AND_COMMUNICATION`: Social and Communication - `CULTURAL_SUPPLIES`: Cultural Supplies - `SPORTS_OUTDOOR`: Sports and Outdoors |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_spreaDouyin Creator Marketplace (Xingtu) Spread Metrics API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) spread metrics for a creator, with channel, period, video-type, assignment, and flow filters. Use it to compare creator spread performance during campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Video type. Available Values: - `PERSONAL_VIDEO`: Personal video - `XINTU_VIDEO`: Xingtu video | |
| range | No | Time range. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| flowType | No | Flow type filter. Available Values: - `EXCLUDE`: Exclude - `INCLUDE`: Include | |
| platform | No | Platform type. Available Values: - `SHORT_VIDEO`: Short video - `LIVE_STREAMING`: Live streaming - `PICTURE_TEXT`: Picture and text - `SHORT_DRAMA`: Short drama | |
| oAuthorId | Yes | Author's unique ID. | |
| onlyAssign | No | Whether to only include assigned videos. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_item_report_detaDouyin Creator Marketplace (Xingtu) Video Details API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) report details for a specified video item. Use it to inspect a video's marketplace report during content performance analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Item's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_item_report_th_aDouyin Creator Marketplace (Xingtu) Item Report Analysis API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) report analysis for a specified video item. Use it to evaluate a video's reported performance during campaign review. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Item's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_item_report_trenDouyin Creator Marketplace (Xingtu) Item Report Trends API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) report trend data for a specified video item. Use it to review how a video's reported performance changes over time. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Item's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_gauthor_author_get_businDouyin Creator Marketplace (Xingtu) Creator Business Card API (V1)Inspect
Returns the Douyin Creator Marketplace (Xingtu) business-card profile for a specified creator. Use it to review creator identity and business context before campaign outreach. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_gauthor_get_author_conteDouyin Creator Marketplace (Xingtu) Content Keyword Analysis API (V1)Inspect
Returns Douyin Creator Marketplace (Xingtu) content keyword analysis for a specified creator. Use it to identify recurring content themes during creator positioning research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| oAuthorId | Yes | Author's unique ID. |
justoneapi_get_api_douyin_xingtu_gw_api_gsearch_search_for_authoDouyin Creator Marketplace (Xingtu) Creator Search API (V1)Inspect
Searches Douyin Creator Marketplace (Xingtu) creators by keyword and structured filters for audience, pricing, content, performance, and campaign fit. Use it to build and compare campaign shortlists. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Creator search sorting. Values: FANS sorts by follower count descending, DEFAULT uses Xingtu score ranking. Available Values: - `DEFAULT`: Platform default score ranking - `FANS`: Sort by follower count descending | |
| gender | No | Creator gender. Accepts MALE (1) or FEMALE (2); native labels in the provider reference are alternate aliases. Available Values: - `MALE`: Male - `FEMALE`: Female | |
| keyword | No | Search keyword. | |
| industry | No | Recommended industry filter. Pass an enum name, its numeric industry ID, or the exact native industry label from the provider reference. Prefer the enum names below when constructing English-language requests. Numeric IDs and native-label aliases remain documented in the original parameter reference. Available Values: - `ALL`: All - `ELECTRONICS_AND_APPLIANCES`: Electronics and Appliances - `SHOPPING`: Shopping - `FOOD_AND_BEVERAGE`: Food and Beverage - `CLOTHING_AND_ACCESSORIES`: Clothing and Accessories - `HEALTHCARE_AND_MEDICAL`: Healthcare and Medical - `MEDICAL_INSTITUTIONS`: Medical Institutions - `HOME_AND_BUILDING_MATERIALS`: Home and Building Materials - `LOCAL_SERVICES`: Local Services - `BUSINESS_SERVICES`: Business Services - `CULTURE_SPORTS_ENTERTAINMENT`: Leisure and Entertainment - `BEAUTY_SERVICES`: Beauty Services - `REAL_ESTATE`: Real Estate - `EDUCATION_AND_TRAINING`: Education and Training - `TRAVEL_AND_TOURISM`: Travel and Tourism - `PUBLIC_SERVICES`: Public Services - `GAMES`: Games - `RETAIL`: Internet E-commerce Services - `TRANSPORTATION_EQUIPMENT`: Transportation Equipment - `AUTOMOTIVE`: Automotive - `AGRICULTURE_FORESTRY_FISHERY`: Agriculture Forestry Fishery - `CHEMICAL_AND_ENERGY`: Chemical and Energy - `ELECTRONICS_AND_ELECTRICAL`: Electronics and Electrical - `MACHINERY_EQUIPMENT`: Machinery Equipment - `MEDIA_AND_INFORMATION`: Media and Information - `LOGISTICS`: Logistics - `TELECOMMUNICATIONS`: Telecommunications - `FINANCIAL_SERVICES`: Financial Services - `CATERING_SERVICES`: Catering Services - `SOFTWARE_TOOLS`: Software Tools - `FRANCHISING_AND_INVESTMENT`: Franchising and Investment - `BEAUTY_AND_COSMETICS`: Beauty and Cosmetics - `MOTHER_BABY_AND_PET`: Mother Baby and Pet - `DAILY_CHEMICALS`: Daily Chemicals - `PHYSICAL_BOOKS`: Physical Books - `SOCIAL_AND_COMMUNICATION`: Social and Communication - `CULTURAL_SUPPLIES`: Cultural Supplies - `SPORTS_OUTDOOR`: Sports and Outdoors | |
| location | No | Creator location filter. Pass native Chinese province or city names separated by commas. Supported province-level areas include Beijing, Tianjin, Hebei, Shanxi, Inner Mongolia, Liaoning, Jilin, Heilongjiang, Shanghai, Jiangsu, Zhejiang, Anhui, Fujian, Jiangxi, Shandong, Henan, Hubei, Hunan, Guangdong, Guangxi, Hainan, Chongqing, Sichuan, Guizhou, Yunnan, Tibet, Shaanxi, Gansu, Qinghai, Ningxia, Xinjiang, Taiwan, Hong Kong, and Macao. Use the provider's original province/city labels, including their native administrative suffixes; these romanized names are explanatory. Original accepted labels and paths: https://docs.justoneapi.com/openapi/douyin-creator-marketplace-xingtu/creator-search-v1-zh.json | |
| fansImage | No | Fan profile filter from Xingtu Fan Image. Pass one or more shortcut values separated by commas. Only the values listed below are accepted. For gender thresholds, pass at most one GENDER_MALE_* value and at most one GENDER_FEMALE_* value. Available values: - Gender: GENDER_MALE_50, GENDER_MALE_60, GENDER_MALE_70, GENDER_MALE_80, GENDER_FEMALE_50, GENDER_FEMALE_60, GENDER_FEMALE_70, GENDER_FEMALE_80; - Age: AGE_18_23, AGE_24_30, AGE_31_40, AGE_41_50, AGE_GT_50; - Device: DEVICE_IPHONE, DEVICE_HUAWEI, DEVICE_XIAOMI, DEVICE_VIVO, DEVICE_OPPO; - City tier: CITY_TIER_1, CITY_TIER_2, CITY_TIER_3, CITY_TIER_4, CITY_TIER_5; - Average order amount: SPEND_0_50, SPEND_50_100, SPEND_100_200, SPEND_200_500, SPEND_GT_500; - Crowd profile: CROWD_REFINED_MOTHER(53 refined mothers), CROWD_URBAN_SILVER(54 urban seniors), CROWD_NEW_WHITE_COLLAR(55 new white-collar workers), CROWD_SENIOR_MIDDLE_CLASS(56 established middle class), CROWD_URBAN_BLUE_COLLAR(57 urban blue-collar workers), CROWD_GEN_Z(58 Generation Z), CROWD_TOWN_MIDDLE_AGED(59 small-town middle-aged and older adults), CROWD_TOWN_YOUTH(60 small-town young adults). Numeric IDs and Chinese labels in parentheses are for reference only and are not accepted as input values. Example: GENDER_FEMALE_50,CROWD_REFINED_MOTHER | |
| authorList | No | Activity-curated creator list under Xingtu Topic Recommendations. Select at most one value. Pass an enum name, its numeric list ID, or the exact native label from the provider reference. Prefer the enum names below. Enum-to-ID mappings: SHORT_LIVE_ENTERTAINMENT_CREATORS=7540478044453486642; SHORT_DRAMA_ACTORS=7591708652957155378; WECHAT_QUICK_CONNECT_CREATORS=7644854622347100210; AI_STAR_PLAN_CREATORS=7658250094571814938; COMMERCE_ADVANTAGE_CREATORS=7648906835038568499; HIGH_VALUE_CREATORS=7656639212045516826; SEEDING_ADVANTAGE_CREATORS=7663404694186033202; BASKETBALL_CREATORS=7501674900550238234; PREMIUM_CONTENT_MEDIA=7586629331582222374; TREND_SETTING_MEDIA=7586616213569781769; FACTORY_TRACEABILITY_MEDIA=7586616269403832370; RUNNING_CREATORS=7501675026170281994; LIGHT_OUTDOOR_CREATORS=7501674458878181413; FITNESS_CREATORS=7501674307430236197; YOGA_CREATORS=7501678481074929674; STREET_SPORTS_CREATORS=7501677564604383259; CYCLING_CREATORS=7501677556094042149; FOOTBALL_CREATORS=7501674900550483994; FISHING_CREATORS=7501676465915215881; BEAUTY_QUALITY_CREATORS=7460387606572875826. Use the enum values in this parameter. Full value descriptions: https://docs.justoneapi.com/openapi/douyin-creator-marketplace-xingtu/creator-search-v1-zh.json | |
| contentTag | No | Creator category filter. Pass Xingtu first-level or second-level category labels separated by commas. Categories cover beauty, fashion, pets, reviews, gaming, anime, travel, automotive, daily life, music, dance, food, parenting, fitness, technology, education, home, creative skills, entertainment, culture, finance, agriculture, comedy, relationships, gardening, property, casual recordings, and media accounts. Use the exact native category labels from the provider reference; these English category names explain meaning and are not replacement request values. Original accepted labels and paths: https://docs.justoneapi.com/openapi/douyin-creator-marketplace-xingtu/creator-search-v1-zh.json | |
| personaTag | No | Creator persona or background filter. Pass Xingtu labels or numeric tag IDs separated by commas. Label groups describe audience cohorts, social identity, on-screen participants, skin type and tone, skin care, parenting stages, interests, occupations, education, verified creator identities, and other lifestyle traits. Use exact native labels or documented numeric IDs from the provider reference; English explanations are not substituted request values. Original accepted labels and paths: https://docs.justoneapi.com/openapi/douyin-creator-marketplace-xingtu/creator-search-v1-zh.json | |
| searchType | No | Search criteria type. Available Values: - `NICKNAME`: By Nickname - `CONTENT`: By Content | |
| isSuperstar | No | Whether to filter celebrity creators. | |
| tonalityTag | No | Creator tonality filter. Pass Xingtu first-level or second-level tonality labels separated by commas. Groups include identity and interests (such as equestrian sports, golf, rugby, fashion, business leaders, automotive interests, academic expertise, and antiques); refined creators (such as design, collectible toys, modeling, style consulting, independent design, visual arts, theater, pop culture, fashion buying, and cinema); and trend-oriented interests (such as surfing, snorkeling, rap, skiing, Pilates, and tennis). Submit exact native labels from the provider reference. Original accepted labels and paths: https://docs.justoneapi.com/openapi/douyin-creator-marketplace-xingtu/creator-search-v1-zh.json | |
| contentTheme | No | Content theme filter. Pass Xingtu second-level theme labels separated by commas. Only labels after the colons in the provider reference are accepted; category headings before the colons are descriptive and must not be submitted. Themes cover makeup, outfit guides, parenting, food reviews and tutorials, automotive life, digital products, acting and comedy, pet care, travel guides, home products, and outdoor fitness. Retain the provider's exact native labels rather than sending translated English labels. Original accepted labels and paths: https://docs.justoneapi.com/openapi/douyin-creator-marketplace-xingtu/creator-search-v1-zh.json | |
| kolPriceType | No | Creator quote type from the current Xingtu marketplace options. Available Values: - `PRODUCT_PLACEMENT_VIDEO`: Product-placement video - `CUSTOM_VIDEO`: Custom video - `CUSTOM_SHORT_DRAMA_EPISODE`: Mini-drama episode - `NATURAL_PLAY_CPM`: CPM naturally - `SHORT_LIVE_SEEDING_VIDEO`: Short-live seeding video - `SHORT_LIVE_WARMUP_VIDEO`: Short-live warm-up video - `CELEBRITY_SHORT_LIVE_SEEDING`: Celebrity short-live seeding - `CELEBRITY_SHORT_LIVE_WARMUP`: Celebrity short-live warm-up - `CELEBRITY_VIDEO`: Celebrity video - `COLLECTION_VIDEO`: Collection video - `DOUYIN_SHORT_VIDEO_CO_CREATION_MAIN_CREATOR`: Douyin short video co-creation - main creator - `DOUYIN_SHORT_VIDEO_CO_CREATION_PARTICIPANT`: Douyin short video co-creation - participant | |
| audienceImage | No | Audience profile filter from Xingtu Audience Image. Pass one or more shortcut values separated by commas. Only the values listed below are accepted. For gender thresholds, pass at most one GENDER_MALE_* value and at most one GENDER_FEMALE_* value. Available values: - Gender: GENDER_MALE_50, GENDER_MALE_60, GENDER_MALE_70, GENDER_MALE_80, GENDER_FEMALE_50, GENDER_FEMALE_60, GENDER_FEMALE_70, GENDER_FEMALE_80; - Age: AGE_18_23, AGE_24_30, AGE_31_40, AGE_41_50, AGE_GT_50; - Device: DEVICE_IPHONE, DEVICE_HUAWEI, DEVICE_XIAOMI, DEVICE_VIVO, DEVICE_OPPO; - City tier: CITY_TIER_1, CITY_TIER_2, CITY_TIER_3, CITY_TIER_4, CITY_TIER_5; - Average order amount: SPEND_0_50, SPEND_50_100, SPEND_100_200, SPEND_200_500, SPEND_GT_500; - Crowd profile: CROWD_REFINED_MOTHER(53 refined mothers), CROWD_URBAN_SILVER(54 urban seniors), CROWD_NEW_WHITE_COLLAR(55 new white-collar workers), CROWD_SENIOR_MIDDLE_CLASS(56 established middle class), CROWD_URBAN_BLUE_COLLAR(57 urban blue-collar workers), CROWD_GEN_Z(58 Generation Z), CROWD_TOWN_MIDDLE_AGED(59 small-town middle-aged and older adults), CROWD_TOWN_YOUTH(60 small-town young adults). Numeric IDs and Chinese labels in parentheses are for reference only and are not accepted as input values. Example: GENDER_FEMALE_50,CROWD_REFINED_MOTHER | |
| followerRange | No | Raw follower count range in min-max format. Example: 1000-2000 means 1,000 to 2,000 followers; 5000000-10000000 means 5 million to 10 million followers. | |
| kolPriceRange | No | Creator quote range in min-max format (e.g., 10000-50000). Requires kolPriceType; omit kolPriceRange to use the full range for the selected quote type. | |
| viralRateRange | No | Viral content rate range in decimal min-max format. Page presets include 0-0.1, 0.1-0.25, 0.25-0.5, 0.5-0.99, and 0.99 or above. For open-ended presets, pass a high upper bound such as 0.99-1. Example: 0.1-0.25. | |
| isCuratedAuthor | No | Whether to include only Xingtu curated creators under Topic Recommendations. | |
| marketingTarget | No | Marketing goal. Accepts BRAND_EXPOSURE (1), CIRCLE_SEEDING (2), or ACTION_CONVERSION (3); the original provider labels are alternate aliases. Available Values: - `BRAND_EXPOSURE`: Brand exposure - `CIRCLE_SEEDING`: Out-of-circle seeding - `ACTION_CONVERSION`: Action conversion | |
| expectedCpeRange | No | Expected CPE range in min-max format. Example values matching Xingtu packs: 0-1, 0-2, 0-3, 0-5, 0-10, 10-1000000. | |
| expectedCpmRange | No | Expected CPM range in min-max format. Example values matching Xingtu packs: 0-10, 0-20, 0-30, 0-50, 0-100, 100-1000000. | |
| expectedPlayRange | No | Expected play count range. Use raw counts in min-max format. Page presets include 10000000 or above, 5000000-10000000, 3000000-5000000, 1000000-3000000, 100000-1000000, and 0-100000. For open-ended presets, pass a high upper bound such as 10000000-1000000000. Example: 1000000-3000000. | |
| progressTaskRange | No | In-progress task count range. Place a colon between the day count and the min-max range; omit either bound for an open range. Example: 30:8- | |
| connectedUserRange | No | Connected user count range. Pass raw user counts in min-max format. Example: 1000000-3000000 | |
| completionRateRange | No | Completion rate range in decimal min-max format. Example values: 0.1-1 for 10% or above, 0.2-1 for 20% or above. | |
| interactionRateRange | No | Interaction rate range in decimal min-max format. Example values: 0.01-1 for 1% or above, 0.02-1 for 2% or above. |
justoneapi_get_api_facebook_get_comment_replies_v1Facebook Comment Replies API (V1)Inspect
Retrieves replies to a specific Facebook post comment using the legacy post ID, comment ID, and expansion token. Use it to inspect a known comment's nested discussion. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| postId | Yes | The legacy numeric identifier of the Facebook post. | |
| commentId | Yes | The unique identifier of the parent Facebook comment. | |
| expansionToken | Yes | The expansion token associated with the parent Facebook comment. |
justoneapi_get_api_facebook_get_post_comments_v1Facebook Post Comments API (V1)Inspect
Retrieves comments for a Facebook post ID with cursor pagination. Use it to review discussion associated with a known public post or continue through subsequent comment pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor for fetching the next set of comments. | |
| postId | Yes | The unique identifier of the Facebook post. |
justoneapi_get_api_facebook_get_profile_id_v1Facebook Get Profile ID API (V1)Inspect
Resolves the Facebook profile ID associated with a submitted profile-path value. Use it to obtain the identifier required before retrieving posts for a known public profile. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The path portion of the Facebook profile URL, such as /<profile-path>. Do not include the scheme or host. |
justoneapi_get_api_facebook_get_profile_posts_v1Facebook Get Profile Posts API (V1)Inspect
Retrieves public posts for a Facebook profile ID with cursor pagination. Use it to browse a known profile's public posting history or continue through subsequent post pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor for fetching the next set of results. | |
| profileId | Yes | The unique Facebook profile ID. |
justoneapi_get_api_facebook_search_post_v1Facebook Post Search API (V1)Inspect
Searches public Facebook posts by keyword with optional inclusive date-range filters and cursor pagination. Use it to find topic-related posts or continue a time-bounded public-content search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor for fetching the next set of results. | |
| endDate | No | End date for the search range (inclusive), formatted as yyyy-MM-dd. | |
| keyword | Yes | Keyword to search for in public posts. Supports basic text matching. | |
| startDate | No | Start date for the search range (inclusive), formatted as yyyy-MM-dd. |
justoneapi_get_api_imdb_news_by_category_query_v1IMDb News by Category API (V1)Inspect
Retrieves IMDb news for a selected top, movie, TV, or celebrity category using language and country preferences. Use it to monitor entertainment news or research a specific category. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| category | Yes | News category to filter by. Available Values: - `TOP`: Top News - `MOVIE`: Movie News - `TV`: TV News - `CELEBRITY`: Celebrity News | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_streaming_picks_query_v1IMDb Streaming Picks API (V1)Inspect
Retrieves IMDb streaming picks for Prime Video using selected language and country preferences. Use it to explore streaming titles for discovery, catalog review, or watchlist research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_awards_summary_query_v1IMDb Awards Summary API (V1)Inspect
Retrieves the IMDb awards summary for a title ID using selected language and country preferences. Use it to research a title's awards record or support awards-focused catalog review. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_base_query_v1IMDb Base Info API (V1)Inspect
Retrieves base IMDb information for a title ID using selected language and country preferences. Use it to perform a lightweight title lookup or populate basic catalog context. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_box_office_summary_v1IMDb Box Office Summary API (V1)Inspect
Retrieves the IMDb box-office summary for a title ID using selected language and country preferences. Use it to research reported theatrical performance or compare titles. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_chart_rankings_v1IMDb Chart Rankings API (V1)Inspect
Retrieves the IMDb Top 250 movie or TV chart selected by ranking type using language and country preferences. Use it to monitor chart positions or compare highly ranked titles. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) | |
| rankingsChartType | Yes | Type of rankings chart to retrieve. Available Values: - `TOP_250`: Top 250 Movies - `TOP_250_TV`: Top 250 TV Shows |
justoneapi_get_api_imdb_title_contribution_questions_v1IMDb Contribution Questions API (V1)Inspect
Retrieves IMDb contribution questions associated with a title ID using selected language and country preferences. Use it to review available prompts for title-data contribution workflows. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_countries_of_origin_v1IMDb Countries of Origin API (V1)Inspect
Retrieves countries of origin associated with an IMDb title ID using selected language and country preferences. Use it to enrich regional catalog metadata or support origin-based analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_critics_review_summary_query_v1IMDb Critics Review Summary API (V1)Inspect
Retrieves the IMDb critics-review summary for a title ID using selected language and country preferences. Use it to review critical reception or compare titles during research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_details_query_v1IMDb Details API (V1)Inspect
Retrieves IMDb title details for a title ID using selected language and country preferences. Use it to support detailed title research or enrich a movie and television catalog. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_did_you_know_query_v1IMDb 'Did You Know' Insights API (V1)Inspect
Retrieves IMDb 'Did You Know' information for a title ID using selected language and country preferences. Use it to research title trivia and add editorial context. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_extended_details_query_v1IMDb Extended Details API (V1)Inspect
Retrieves extended IMDb details for a title ID using selected language and country preferences. Use it to enrich a title catalog or perform deeper research after a basic lookup. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_more_like_this_query_v1IMDb Recommendations API (V1)Inspect
Retrieves IMDb titles similar to a specified title ID using selected language and country preferences. Use it to support related-title discovery, recommendations, or catalog curation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_plot_query_v1IMDb Plot Summary API (V1)Inspect
Retrieves IMDb plot information for a title ID using selected language and country preferences. Use it to review a movie or series storyline or enrich title descriptions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_redux_overview_query_v1IMDb Redux Overview API (V1)Inspect
Retrieves the IMDb Redux overview for a title ID using selected language and country preferences. Use it to obtain a consolidated title overview for catalog review or content research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_release_expectation_query_v1IMDb Release Expectation API (V1)Inspect
Retrieves IMDb release-expectation information for a title ID using selected language and country preferences. Use it to monitor a title's release context or support release-planning research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_top_cast_and_crew_v1IMDb Top Cast and Crew API (V1)Inspect
Retrieves IMDb top cast and crew information for a title ID using selected language and country preferences. Use it to research principal talent or enrich title credits. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_imdb_title_user_reviews_summary_query_v1IMDb User Reviews Summary API (V1)Inspect
Retrieves the IMDb user-reviews summary for a title ID using selected language and country preferences. Use it to review audience reception or support title comparison and research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The IMDb title identifier in tt<digits> format. | |
| languageCountry | No | Language and country preferences. Available Values: - `en_US`: English (US) - `fr_CA`: French (Canada) - `fr_FR`: French (France) - `de_DE`: German (Germany) - `hi_IN`: Hindi (India) - `it_IT`: Italian (Italy) - `pt_BR`: Portuguese (Brazil) - `es_ES`: Spanish (Spain) - `es_US`: Spanish (US) - `es_MX`: Spanish (Mexico) |
justoneapi_get_api_instagram_general_search_v1Instagram General Search API (V1)Inspect
Performs a general search on Instagram by keyword with token-based pagination. Use it to discover matching results, research topics, and continue through subsequent result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | The keyword to search for on Instagram. | |
| paginationToken | No | Pagination token from the previous response. Omit it for the first page. |
justoneapi_get_api_instagram_get_comment_replies_v1Instagram Comment Reply List API (V1)Inspect
Retrieves replies to a specific Instagram post comment by media and comment IDs, with cursor pagination. Use it to inspect threaded discussion and continue through reply pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| minId | No | Pagination cursor returned as next_min_child_cursor from the previous response. | |
| mediaId | Yes | The numeric media ID of the Instagram post. | |
| commentId | Yes | The parent comment ID whose replies are to be retrieved. |
justoneapi_get_api_instagram_get_post_comments_v1Instagram Post Comment List API (V1)Inspect
Retrieves top-level comments for an Instagram post by shortcode, with cursor pagination and popular or newest sorting. Use it to review audience feedback or analyze discussion around a known post. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | The unique shortcode for the Instagram post. | |
| minId | No | Pagination cursor returned as next_min_id from the previous response. | |
| sortOrder | No | Sort order for the comments. Available Values: - `popular`: Popular - `newest`: Newest |
justoneapi_get_api_instagram_get_post_detail_v1Instagram Post Details API (V1)Inspect
Retrieves an Instagram post by its shortcode. Use it to look up a known post before content review, archiving, comment analysis, or related workflows. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | The unique shortcode from the Instagram post URL. |
justoneapi_get_api_instagram_get_user_detail_v1Instagram User Profile API (V1)Inspect
Retrieves an Instagram user profile by username. Use it to review a known account before creator research, brand monitoring, or related post analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | The Instagram username whose profile details are to be retrieved. |
justoneapi_get_api_instagram_get_user_detail_v2Instagram User Profile API (V2)Inspect
Retrieves an Instagram user profile by username. Use it to review a known account before creator research, brand monitoring, or related post analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | The Instagram username whose profile details are to be retrieved. |
justoneapi_get_api_instagram_get_user_posts_v1Instagram User Published Posts API (V1)Inspect
Retrieves posts published by an Instagram user with token-based pagination. Use it to browse a known account's post history or continue through subsequent result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | The Instagram username whose published posts are to be retrieved. | |
| paginationToken | No | Token used for retrieving the next page of results. |
justoneapi_get_api_instagram_search_hashtag_posts_v1Instagram Hashtag Posts Search API (V1)Inspect
Searches Instagram posts by hashtag with cursor pagination. Use it to explore tagged content, monitor topics, and continue through subsequent result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| hashtag | Yes | The hashtag or keyword to search for. | |
| endCursor | No | Cursor used for retrieving the next page of results. |
justoneapi_get_api_instagram_search_reels_v1Instagram Reels Search API (V1)Inspect
Searches Instagram Reels by keyword or hashtag with token-based pagination. Use it to discover short-form videos, monitor topics, and continue through matching results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | The search keyword or hashtag to filter Reels. | |
| paginationToken | No | Token used for retrieving the next page of results. |
justoneapi_get_api_jd_get_item_comments_v1JD.com Product Comments API (V1)Inspect
Retrieve paginated customer comments for a JD.com product identified by item ID. Use it to review buyer feedback for a known product. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for paginated comments. | |
| itemId | Yes | A unique product identifier on JD.com (item ID). |
justoneapi_get_api_jd_get_item_description_images_v1JD.com Product Description Images API (V1)Inspect
Retrieve JD.com product description images and product attributes by item ID. Use it to review product introductions for catalog research and product presentation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | A unique product identifier on JD.com (item ID). |
justoneapi_get_api_jd_get_item_detail_v1JD.com Product Details API (V1)Inspect
Retrieve JD.com product details for a known item ID. Use it to inspect an individual product after finding its identifier. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | A unique product identifier on JD.com (item ID). |
justoneapi_get_api_jd_get_item_detail_v3JD.com Product Details API (V3)Inspect
Retrieve JD.com product details by item ID. Use it to review product information and description images for catalog research or product displays. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | A unique product identifier on JD.com (item ID). |
justoneapi_get_api_jd_get_item_detail_v4JD.com Product Details API (V4)Inspect
Retrieve JD.com product details by item ID. Use it to review product information and images for catalog research or ecommerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | A unique product identifier on JD.com (item ID). |
justoneapi_get_api_jd_get_item_price_v1JD.com Product Price API (V1)Inspect
Retrieve the current JD.com product price for a known item ID. Use it to check a product's price before catalog comparison or purchase analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | A unique product identifier on JD.com (item ID). |
justoneapi_get_api_jd_get_shop_item_list_v1JD.com Shop Product List API (V1)Inspect
Retrieve a page of products from a JD.com shop identified by shop ID. Use it to browse a seller's catalog and collect item IDs for follow-up lookups. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for the paginated shop product list. | |
| shopId | Yes | A unique shop identifier on JD.com (Shop ID). |
justoneapi_get_api_jd_search_item_list_v1JD.com Product Search API (V1)Inspect
Search JD.com products by keyword with page-based pagination. Use it to discover products and collect item IDs for follow-up lookups. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| keyword | Yes | Search keyword. |
justoneapi_get_api_kuaishou_get_user_detail_v1Kuaishou User Profile API (V1)Inspect
Retrieve the public profile for a Kuaishou user identified by user ID. Use it to inspect an account found through user or video results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The unique user ID on Kuaishou. |
justoneapi_get_api_kuaishou_get_user_video_list_v2Kuaishou User Published Videos API (V2)Inspect
Retrieve public videos published by a Kuaishou user, with optional cursor-based pagination. Use it to review a creator's content history or select videos for detail and comment requests. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The unique user ID on Kuaishou. | |
| pcursor | No | Pagination cursor for subsequent pages. |
justoneapi_get_api_kuaishou_get_video_comment_v1Kuaishou Video Comments APIInspect
Retrieve public comments for a Kuaishou video, with optional cursor-based pagination. Use it to review audience discussion and continue through additional comment pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pcursor | No | Pagination cursor for subsequent pages. | |
| videoId | Yes | The Kuaishou video identifier or numeric refer_photo_id returned by a related response. |
justoneapi_get_api_kuaishou_get_video_detail_v2Kuaishou Video Details API (V2)Inspect
Retrieve public details for a Kuaishou video identified by its video ID. Use it to inspect a selected video after search or user-published-video discovery. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| videoId | Yes | The unique video identifier returned by Kuaishou. |
justoneapi_get_api_kuaishou_search_user_v2Kuaishou User Search API (V2)Inspect
Search public Kuaishou user accounts by keyword with page-number pagination. Use it to discover relevant creators or accounts before requesting profile and published-video data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for results, starting from 1. | |
| keyword | Yes | The search keyword to find users. |
justoneapi_get_api_kuaishou_search_video_v1Kuaishou Video Search API (V1)Inspect
Search public Kuaishou videos by keyword with cursor-based pagination. Use it to discover relevant videos and continue through additional result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor returned by the previous response. Omit or leave blank for the first page; maximum 256 characters. | |
| keyword | Yes | The search keyword to find videos. |
justoneapi_get_api_kuaishou_search_video_v2Kuaishou Video Search API (V2)Inspect
Search public Kuaishou videos by keyword with page-number pagination. Use it to discover relevant videos and browse results by page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for results, starting from 1. | |
| keyword | Yes | The search keyword to find videos. |
justoneapi_get_api_linkedin_get_post_comments_v1LinkedIn Post Comments API (V1)Inspect
Retrieves LinkedIn comments for an activity post with relevance or recent sorting, page-based navigation, a pagination token, and optional share URN. Use it to review public discussion around known professional content. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting from 1. | |
| postId | Yes | LinkedIn post ID. | |
| shareUrn | No | Optional share URN for a shared post. | |
| sortOrder | No | Comment sort order. Available Values: - `RELEVANCE`: Sort comments by relevance - `RECENT`: Sort comments from most recent | |
| paginationToken | No | Pagination token returned by a previous response. |
justoneapi_get_api_linkedin_get_user_detail_v1LinkedIn User Profile API (V1)Inspect
Retrieves a LinkedIn profile by username, including documented core profile fields such as name and headline. Use it to inspect a person's professional background or before requesting published posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | LinkedIn username from the profile URL, for example jack from linkedin.com/in/jack. |
justoneapi_get_api_linkedin_get_user_posts_v1LinkedIn User Published Posts API (V1)Inspect
Retrieves posts published, commented on, or reacted to by a LinkedIn member using a profile URL, activity type, offset, and pagination token. Use it to review public professional activity and continue through additional result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Full LinkedIn profile URL. | |
| type | No | User activity type. Available Values: - `POSTS`: Posts published by the user - `COMMENTS`: Posts commented on by the user - `REACTIONS`: Posts reacted to by the user | |
| start | No | Pagination offset starting from 0, normally increasing by 50. | |
| paginationToken | No | Pagination token returned by a previous response. |
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publish_2QQ Huxuan Creator Marketplace Video Account Creator Details API (V1)Inspect
Retrieves QQ Huxuan Video Account creator details for a known creator app ID. Use it to review a shortlisted video creator before Tencent Huxuan campaign selection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| appId | Yes | Video Account creator app ID. |
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publish_3QQ Huxuan Creator Marketplace Video Account Recent Videos API (V1)Inspect
Lists videos from a QQ Huxuan Video Account creator within a required date range, with a choice of all, Huxuan order, hot, or personal videos. Use it to review a shortlisted creator's content for campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. The first page is 1. | |
| appId | Yes | Video Account creator app ID. | |
| endDate | Yes | End date in yyyyMMdd format. | |
| beginDate | Yes | Start date in yyyyMMdd format. | |
| videoType | No | Tencent Huxuan video type filter. Available Values: - `ALL`: All videos - `ORDER`: QQ Huxuan order videos - `HOT`: Hot videos - `PERSON`: Personal videos |
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publish_4QQ Huxuan Creator Marketplace Hot Content Trends API (V1)Inspect
Lists QQ Huxuan hot Video Account content by month and creator category, with six descending sort metrics and page-number pagination. Use it to research monthly content trends for Tencent Huxuan campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. Each page contains up to 48 items. | |
| sort | No | Sort metric. Results are sorted in descending order. Available Values: - `INTERACTION`: Interaction count - `PLAY`: Play count - `THUMB_LIKE`: Thumbs-up like count - `HEART_LIKE`: Heart like count - `COMMENT`: Comment count - `SHARE`: Share count | |
| month | No | Statistics month in yyyy-MM format. Omit to use the latest month available on QQ Huxuan. | |
| category | No | Creator category. ALL includes every category. Available Values: - `ALL`: All creator categories - `FOOD`: Food - `LIFESTYLE`: Lifestyle - `COMEDY`: Comedy - `EMOTION`: Emotion and relationships - `SOCIETY`: Society - `HUMANITIES_ARTS`: Humanities and arts - `DRAMA`: Drama - `ENTERTAINMENT`: Entertainment - `TECHNOLOGY`: Technology - `FINANCE`: Finance - `FILM_TV_VARIETY`: Film, television and variety shows - `GAMING`: Gaming - `PARENTING`: Parenting - `MUSIC`: Music - `TRAVEL`: Travel - `SPORTS`: Sports - `SCIENCE`: Science education - `AUTOMOTIVE`: Automotive - `EDUCATION`: Education - `CAREER`: Career - `HEALTH`: Health - `PETS`: Pets |
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publisherQQ Huxuan Creator Marketplace Video Account Creator Search API (V1)Inspect
Searches or browses QQ Huxuan Video Account creators by optional nickname keyword with page-number pagination. Use it to discover and shortlist video creators for Tencent Huxuan campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. The first page is 1. | |
| keyword | No | Creator nickname keyword. Leave empty to browse the default marketplace list. |
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_mp_publisher_detQQ Huxuan Creator Marketplace Official Account Creator Details API (V1)Inspect
Retrieves QQ Huxuan Official Account creator details for a known creator app ID. Use it to review a shortlisted publisher before Tencent Huxuan campaign selection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| appId | Yes | Official Account creator app ID. |
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_mp_publisher_getQQ Huxuan Creator Marketplace Official Account Article List API (V1)Inspect
Lists articles from a QQ Huxuan Official Account creator within a required date range, with an optional title keyword and a choice between all articles and Huxuan order articles. Use it to review a publisher's content for campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. The first page is 1. | |
| appId | Yes | Official Account creator app ID. | |
| endDate | Yes | End date in yyyyMMdd format. | |
| keyword | No | Article title keyword. Leave empty to return all matched articles. | |
| startDate | Yes | Start date in yyyyMMdd format. | |
| articleType | No | Tencent Huxuan article type filter. Available Values: - `ALL`: All articles - `ORDER`: QQ Huxuan order articles |
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_mp_publisher_seaQQ Huxuan Creator Marketplace Official Account Creator Search API (V1)Inspect
Searches or browses QQ Huxuan Official Account creators by optional nickname or account keyword with page-number pagination. Use it to discover and shortlist publishers for Tencent Huxuan campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. The first page is 1. | |
| keyword | No | Creator nickname or account keyword. Leave empty to browse the default marketplace list. |
justoneapi_get_api_reddit_get_post_comments_v1Reddit Post Comments API (V1)Inspect
Retrieves comments for a Reddit post with pagination-token support. Use it to review a thread's discussion or continue through additional comment results for a known post. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination token for the next page of results. | |
| postId | Yes | The unique identifier of the Reddit post. |
justoneapi_get_api_reddit_get_post_detail_v1Reddit Post Details API (V1)Inspect
Retrieves details for a Reddit post identified by its full post ID. Use it to look up a known post before discussion review, content analysis, or subsequent comment retrieval. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| postId | Yes | The Reddit post identifier in t3_<post-id> format. |
justoneapi_get_api_reddit_search_v1Reddit Keyword Search API (V1)Inspect
Searches Reddit posts by keyword with an optional continuation token. Use it to discover topic-related discussions or continue through additional search-result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | Pagination token to retrieve the next set of results. | |
| keyword | Yes | Search query keywords. |
justoneapi_get_api_search_v1Social Media Cross-Platform Search API (V1)Inspect
Searches recent content across news, Weibo, WeChat, Zhihu, Douyin, Xiaohongshu, Bilibili, and Kuaishou with source and time filters. Use it to monitor a topic across multiple platforms. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | End time of the search period (yyyy-MM-dd HH:mm:ss). Required for initial request. | |
| start | No | Start time of the search period (yyyy-MM-dd HH:mm:ss). Required for initial request. | |
| source | No | Target social media platform for search filtering. Available Values: - `ALL`: All platforms - `NEWS`: News - `WEIBO`: Sina Weibo - `WEIXIN`: Weixin (WeChat) - `ZHIHU`: Zhihu - `DOUYIN`: Douyin (TikTok China) - `XIAOHONGSHU`: Xiaohongshu (Little Red Book) - `BILIBILI`: Bilibili - `KUAISHOU`: Kuaishou | |
| keyword | No | Search query string. Supports these five syntax forms: - AND (&&): A && B matches content containing both A and B. - OR (||): A || B matches content containing A or B. - Exclusion (-): -A matches content that does not contain A. - Parentheses (): (A && B) || C matches content containing C, or both A and B. - English double quotes (""): "A" disables tokenization and requires an exact match for A. | |
| nextCursor | No | Pagination cursor provided by the 'nextCursor' field in the previous response. |
justoneapi_get_api_shopee_get_item_detail_v1Shopee Item Details API (V1)Inspect
Retrieves Shopee item details by marketplace site and item ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. |
justoneapi_get_api_shopee_get_item_detail_v2Shopee Item Details API (V2)Inspect
Retrieves Shopee item details by marketplace site, shop ID, and item ID using the version 2 data source. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_get_item_installments_v1Shopee Item Installments and Amounts API (V1)Inspect
Retrieves installment and amount information for a Shopee item. This operation supports Taiwan and Indonesia but not Thailand. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Taiwan and Indonesia are supported for this operation. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| shopId | Yes | Shopee shop ID. | |
| detailLevel | No | Detail level for the installment response. |
justoneapi_get_api_shopee_get_item_review_models_v1Shopee Item Review Model Distribution API (V1)Inspect
Retrieves the review distribution across SKU models for a Shopee item. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_get_item_reviews_v1Shopee Item Reviews API (V1)Inspect
Retrieves reviews for a specified Shopee item with offset pagination and a rating filter. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| offset | No | Zero-based result offset. | |
| shopId | Yes | Shopee shop ID. | |
| ratingType | No | Rating filter from 0 to 5, where 0 includes all ratings. |
justoneapi_get_api_shopee_get_item_review_tags_v1Shopee Item Review Tags API (V1)Inspect
Retrieves review tags for a Shopee item in the selected marketplace site. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_get_item_sku_matrix_v1Shopee Item SKU Matrix API (V1)Inspect
Retrieves the SKU option matrix for a Shopee item in the selected marketplace site. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_get_item_sku_models_v1Shopee Item SKU Models API (V1)Inspect
Retrieves observed SKU models for a Shopee item with offset and rating filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| offset | No | Zero-based result offset. | |
| shopId | Yes | Shopee shop ID. | |
| ratingType | No | Rating filter from 0 to 5, where 0 includes all ratings. |
justoneapi_get_api_shopee_get_item_snapshot_v1Shopee Item Display Snapshot API (V1)Inspect
Retrieves a display snapshot for a Shopee item in the selected marketplace site. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| itemId | Yes | Shopee item ID. | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_get_search_facets_v1Shopee Search Category Facets API (V1)Inspect
Retrieves category facets for a Shopee product search keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| keyword | Yes | Product search keyword. |
justoneapi_get_api_shopee_get_shop_base_v1Shopee Shop Basic Profile API (V1)Inspect
Retrieves the basic Shopee shop profile by username and marketplace site. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| username | Yes | Shopee shop username. |
justoneapi_get_api_shopee_get_shop_categories_v1Shopee Shop Categories API (V1)Inspect
Retrieves Shopee shop categories using a zero-based result offset. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| offset | No | Zero-based result offset. | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_get_shop_detail_v1Shopee Shop Details API (V1)Inspect
Retrieves detailed Shopee shop information by username and marketplace site. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| username | Yes | Shopee shop username. |
justoneapi_get_api_shopee_get_shop_item_list_v1Shopee Shop Item List API (V1)Inspect
Retrieves Shopee item cards for a shop username in the selected marketplace site. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| username | Yes | Shopee shop username. |
justoneapi_get_api_shopee_get_shop_reviews_rich_v1Shopee Rich Shop Reviews API (V1)Inspect
Retrieves enriched Shopee shop reviews using a zero-based result offset. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| offset | No | Zero-based result offset. | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_get_shop_reviews_v1Shopee Shop Reviews API (V1)Inspect
Retrieves Shopee shop reviews with offset pagination and a rating filter. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| offset | No | Zero-based result offset. | |
| shopId | Yes | Shopee shop ID. | |
| ratingType | No | Rating filter from 0 to 5, where 0 includes all ratings. |
justoneapi_get_api_shopee_get_shop_seo_v1Shopee Shop Profile and Rating Summary API (V1)Inspect
Retrieves a Shopee shop profile and rating summary by marketplace site and shop ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| shopId | Yes | Shopee shop ID. |
justoneapi_get_api_shopee_search_item_list_v1Shopee Item Search API (V1)Inspect
Searches Shopee items by keyword in the selected marketplace site. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand | |
| keyword | Yes | Product search keyword. |
justoneapi_get_api_taobao_get_item_comment_v3Taobao and Tmall Product Reviews API (V3)Inspect
Retrieves Taobao and Tmall product reviews by item ID with page-based pagination and configurable sorting. Use it to analyze customer feedback. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). | |
| orderType | No | Sort order for the result set. Available Values: - `feedbackdate`: Sort by feedback date - `general`: General sorting |
justoneapi_get_api_taobao_get_item_description_v1Taobao and Tmall Product Description Images API (V1)Inspect
Retrieves Taobao or Tmall product description HTML and a separate list of description images by item ID. Use it to collect listing description assets for catalog preparation and product content review. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v1Taobao and Tmall Product Details API (V1)Inspect
Retrieves Taobao or Tmall product details by item ID through the V1 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v2Taobao and Tmall Product Details API (V2)Inspect
Retrieves Taobao or Tmall product details by item ID, including product attributes, main images and video, shop information, shipping information, and SKU prices and stock. Use it for product sourcing, catalog research, and inventory monitoring. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v3Taobao and Tmall Product Details API (V3)Inspect
Retrieves Taobao or Tmall product details by item ID through the V3 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v4Taobao and Tmall Product Details API (V4)Inspect
Retrieves Taobao or Tmall product details by item ID through the V4 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v5Taobao and Tmall Product Details API (V5)Inspect
Retrieves Taobao or Tmall product details by item ID through the V5 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v6Taobao and Tmall Product Details API (V6)Inspect
Retrieves Taobao or Tmall product details by item ID through the recommended V6 endpoint, including approximate sales, shipping fees and free-shipping status. Use it for product research and ecommerce monitoring. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v8Taobao and Tmall Product Details API (V8)Inspect
Retrieves Taobao or Tmall product details by item ID through the V8 endpoint, which provides accurate SKU quantity information. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_item_detail_v9Taobao and Tmall Product Details API (V9)Inspect
Retrieves Taobao or Tmall product details by item ID through the V9 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_get_shop_item_list_v1Taobao and Tmall Shop Product List API (V1)Inspect
Retrieves products from a Taobao or Tmall shop by seller or user ID, with page-based pagination and default or sales sorting. Use it to browse or monitor a seller catalog. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Sort order for the result set. Available Values: - `_sale`: Sales - `_default`: Default | |
| userId | Yes | Shop identifier. Also known as Seller ID or User ID (they refer to the same value). |
justoneapi_get_api_taobao_get_shop_item_list_v2Taobao and Tmall Shop Product List API (V2)Inspect
Retrieves products from a Taobao or Tmall shop using both seller or user ID and shop ID, with page-based pagination and sorting by sales, new arrivals, credit, or price. Use it to browse a known shop catalog. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Sort order for the result set. Available Values: - `sales-des`: Sales, highest first - `new-des`: New arrivals, newest first - `credit-des`: Credit, highest first - `price-asc`: Price, lowest first - `price-des`: Price, highest first | |
| shopId | Yes | Unique shop identifier on Taobao/Tmall (shop ID). | |
| userId | Yes | Shop identifier. Also known as Seller ID or User ID (they refer to the same value). |
justoneapi_get_api_taobao_get_shop_item_list_v3Taobao and Tmall Shop Product List API (V3)Inspect
Retrieves products from a Taobao or Tmall shop by seller ID and shop ID with page-based pagination and configurable sorting, including a new-arrivals sort for discovering a shop's latest products. Use it to browse or monitor a known seller's catalog. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Sort order for the result set. Available Values: - `comprehensive`: Comprehensive sorting - `sales`: Sort by sales volume - `new`: Sort by new arrivals, newest first - `favorites`: Sort by favorites | |
| shopId | Yes | Unique shop identifier on Taobao/Tmall (shop ID). | |
| userId | Yes | Shop identifier. Also known as Seller ID or User ID (they refer to the same value). |
justoneapi_get_api_taobao_get_shop_item_list_v4Taobao and Tmall Shop Product List API (V4)Inspect
Retrieves products from a Taobao or Tmall shop by seller ID with page-based pagination. Use it to browse or monitor a known seller's catalog across result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sellerId | Yes | Taobao/Tmall seller user ID used to identify the shop. |
justoneapi_get_api_taobao_get_social_feed_v1Taobao and Tmall Product Questions API (V1)Inspect
Retrieves the Taobao or Tmall product social feed by item ID with page-based pagination. Use it to review product questions and related discussion during customer-concern or product research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| itemId | Yes | Unique product identifier on Taobao/Tmall (item ID). |
justoneapi_get_api_taobao_search_item_list_v1Taobao and Tmall Product Search API (V1)Inspect
Searches Taobao and Tmall products by keyword with page, sort, optional Tmall-only, and inclusive price-range filters. Use it to discover products and narrow ecommerce research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Sort order for the result set. Available Values: - `_sale`: Sales - `_bid`: Price: High to Low - `bid`: Price: Low to High - `_coefp`: General | |
| tmall | No | Whether to filter results to Tmall only. | |
| keyword | Yes | Search keyword. | |
| endPrice | No | Maximum price filter (inclusive). | |
| startPrice | No | Minimum price filter (inclusive). |
justoneapi_get_api_taobao_search_item_list_v2Taobao and Tmall Product Search API (V2)Inspect
Searches Taobao and Tmall products by keyword with page-based pagination and returns results sorted by sales. Use it to discover popular products for ecommerce research, catalog analysis, or product selection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination, starting from 1. | |
| keyword | Yes | Search keyword. |
justoneapi_get_api_tiktok_get_post_comment_v1TikTok Post Comments API (V1)Inspect
Retrieves comments for a TikTok post with cursor pagination. Use it to review audience discussion, continue through comment pages, or support comment analysis for a known post. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor. Start with '0'. | |
| awemeId | Yes | The unique ID of the TikTok post (awemeId). |
justoneapi_get_api_tiktok_get_post_detail_v1TikTok Post Details API (V1)Inspect
Retrieves details for a TikTok post identified by its post ID. Use it to look up a known TikTok video before content review, reporting, or related engagement analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| postId | Yes | The unique ID of the TikTok post. |
justoneapi_get_api_tiktok_get_post_sub_comment_v1TikTok Comment Replies API (V1)Inspect
Retrieves replies to a specific comment on a TikTok post with cursor pagination. Use it to inspect threaded discussions and continue through reply pages for a known post comment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor. Start with '0'. | |
| awemeId | Yes | The unique ID of the TikTok post. | |
| commentId | Yes | The unique ID of the comment to retrieve replies for. |
justoneapi_get_api_tiktok_get_user_detail_v1TikTok User Profile API (V1)Inspect
Retrieves a TikTok user profile by public username or secUid. Use it to look up a known account for creator research, profile review, or subsequent user-post retrieval. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| secUid | No | The unique security ID of the user. | |
| uniqueId | No | The public TikTok handle or username of the user. |
justoneapi_get_api_tiktok_get_user_post_v1TikTok User Published Posts API (V1)Inspect
Retrieves posts published by a TikTok user identified by secUid, with cursor pagination and latest or popular sorting. Use it to browse a creator's posting history or continue through their public post feed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sorting criteria for the user's posts. Available Values: - `LATEST`: Newest posts first (default) - `MOST_POPULAR`: Most popular posts first | |
| cursor | No | Pagination cursor. Use '0' for the first page, then use the max_cursor value returned in the previous response. | |
| secUid | Yes | The opaque security ID returned for the TikTok user. |
justoneapi_get_api_tiktok_search_post_v1TikTok Post Search API (V1)Inspect
Searches TikTok posts by keyword with offset pagination plus sorting, publish-time, and region controls. Use it to support regional content discovery, topic research, or monitoring keyword-related videos. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Pagination offset, starting from 0 and stepping by 20. | |
| region | No | ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB'). | |
| keyword | Yes | Search keywords. | |
| sortType | No | Sorting criteria for search results. Available Values: - `RELEVANCE`: Relevance (Default) - `MOST_LIKED`: Most Liked | |
| publishTime | No | Filter posts by publishing time. Available Values: - `ALL`: All Time - `ONE_DAY`: Last 24 Hours - `ONE_WEEK`: Last 7 Days - `ONE_MONTH`: Last 30 Days - `THREE_MONTHS`: Last 90 Days - `HALF_YEAR`: Last 180 Days |
justoneapi_get_api_tiktok_shop_get_product_detail_v1TikTok Shop Product Details API (V1)Inspect
Retrieves the public TikTok Shop product detail for a product ID in a selected region. Use it to inspect a known regional product after search or catalog discovery. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | Target region for product detail. Available Values: - `US`: United States - `GB`: United Kingdom - `FR`: France - `SG`: Singapore - `MY`: Malaysia - `PH`: Philippines - `TH`: Thailand - `VN`: Vietnam - `ID`: Indonesia | |
| productId | Yes | TikTok Shop Product ID. |
justoneapi_get_api_tiktok_shop_search_products_v1TikTok Shop Product Search API (V1)Inspect
Searches TikTok Shop products by keyword within a selected region, with offset and page-token pagination. Use it to discover regional products and continue through search results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Search result offset. | |
| region | No | Target region for product search. Available Values: - `US`: United States - `GB`: United Kingdom - `FR`: France - `SG`: Singapore - `MY`: Malaysia - `PH`: Philippines - `TH`: Thailand - `VN`: Vietnam - `ID`: Indonesia | |
| keyword | Yes | Search keyword. | |
| pageToken | No | Pagination token for the next page. |
justoneapi_get_api_toutiao_get_article_detail_v1Toutiao Article Details API (V1)Inspect
Retrieves details for a Toutiao article identified by its article ID. Use it to look up a known article for content review, archiving, or related media analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The unique identifier of the Toutiao article. |
justoneapi_get_api_toutiao_get_user_detail_v1Toutiao User Profile API (V1)Inspect
Retrieves a Toutiao user profile identified by user ID. Use it to look up a known account for creator research, profile review, or related article analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The unique identifier of the Toutiao user. |
justoneapi_get_api_toutiao_get_user_id_v1Toutiao User ID API (V1)Inspect
Resolves the user ID associated with a Toutiao profile URL. Use it to convert a known profile link into the identifier required for subsequent user-profile lookups. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userProfileUrl | Yes | The Toutiao user profile URL used to resolve the user ID. |
justoneapi_get_api_toutiao_get_video_detail_v1Toutiao Video Details API (V1)Inspect
Retrieves details for a Toutiao video identified by its video ID. Use it to look up a known video for content review, archiving, or related media analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| videoId | Yes | The unique identifier of the Toutiao video. |
justoneapi_get_api_toutiao_search_v2Toutiao Web Keyword Search API (V2)Inspect
Searches Toutiao web articles by keyword. Use it to discover relevant articles for topic research, media monitoring, or source collection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Search keyword or query. |
justoneapi_get_api_twitter_get_post_comments_v1Twitter Post Comments API (V1)Inspect
Retrieves the latest comments for an X (Twitter) post identified by tweet ID, with cursor pagination. Use it to review recent discussion on a known post and continue through additional comment pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor returned by the previous response. | |
| tweetId | Yes | The unique identifier of the X (Twitter) post. |
justoneapi_get_api_twitter_get_post_detail_v1Twitter Post Detail API (V1)Inspect
Retrieves the full detail of an X (Twitter) post identified by its tweet ID. Use it to inspect a known post after finding it through search, a user timeline, or an existing post URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tweetId | Yes | The unique identifier of the X (Twitter) post. |
justoneapi_get_api_twitter_get_user_detail_v1Twitter User Profile API (V1)Inspect
Retrieves an X (Twitter) user profile identified by its numeric Rest ID. Use it to review a known account before monitoring its posts or conducting creator and account research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| restId | Yes | The unique numeric identifier (Rest ID) for the X user. |
justoneapi_get_api_twitter_get_user_posts_v1Twitter User Published Posts API (V1)Inspect
Retrieves posts published by an X (Twitter) user identified by Rest ID, with cursor pagination. Use it to browse a known account's timeline or continue through its public post history. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor for navigating through long timelines. | |
| restId | Yes | The unique numeric identifier (Rest ID) for the X user. |
justoneapi_get_api_twitter_search_v1Twitter Search Timeline API (V1)Inspect
Searches X (Twitter) by keyword across top, latest, media, people, or list result modes with cursor pagination. Use it to find public conversations, accounts, media, or lists related to a topic. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor returned by the previous response. | |
| keyword | Yes | Search keyword. | |
| searchType | No | Search result type. Available Values: - `TOP`: Top search results - `LATEST`: Latest search results - `MEDIA`: Media search results - `PEOPLE`: People search results - `LISTS`: List search results |
justoneapi_get_api_weibo_get_fans_v1Weibo User Fans API (V1)Inspect
Retrieves a page of fan accounts that follow a Weibo user identified by UID. Use it to browse the account's follower audience or continue through its fan list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Weibo User ID (UID). | |
| page | No | Page number, starting with 1. |
justoneapi_get_api_weibo_get_followers_v1Weibo User Followers API (V1)Inspect
Retrieves a page of accounts followed by a Weibo user identified by UID. Use it to examine the account's outgoing follow network or continue through its following list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Weibo User ID (UID). | |
| page | No | Page number, starting with 1. |
justoneapi_get_api_weibo_get_post_comments_v1Weibo Post Comments API (V1)Inspect
Retrieves comments for a Weibo post identified by MID, with optional maxId cursor pagination and time or hot sorting. Use it to review audience discussion, continue through comment pages, or support moderation and feedback analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mid | Yes | Weibo post mid. | |
| sort | No | Sort order for the result set. Available Values: - `TIME`: Time - `HOT`: Hot | |
| maxId | No | Pagination cursor returned by the previous response. |
justoneapi_get_api_weibo_get_user_detail_v3Weibo User Profile API (V3)Inspect
Retrieves a Weibo user profile identified by UID. Use it to look up a known account for creator research, profile review, or subsequent retrieval of that user's posts and videos. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Weibo User ID (UID). |
justoneapi_get_api_weibo_get_user_post_v1Weibo User Published Posts API (V1)Inspect
Retrieves posts published by a Weibo user identified by UID, using page numbers and a required sinceId cursor after the first page. Use it to browse an account's posting history or continue through its post feed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Weibo User ID (UID). | |
| page | No | Page number, starting with 1. | |
| sinceId | No | Pagination cursor (since_id). Required if page > 1. |
justoneapi_get_api_weibo_get_user_video_list_v1Weibo User Video List API (V1)Inspect
Retrieves a Weibo user's video waterfall feed by UID, with an optional cursor from a prior response. Use it to browse videos published by a known account or continue through its video feed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Weibo User ID (UID). | |
| cursor | No | Pagination cursor returned by the previous response. |
justoneapi_get_api_weibo_get_weibo_detail_v1Weibo Post Details API (V1)Inspect
Retrieves details for a Weibo post identified by its post ID. Use it to look up a known post for content review, archiving, or related engagement analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Weibo post ID. |
justoneapi_get_api_weibo_hot_search_v1Weibo Hot Search API (V1)Inspect
Retrieves the current Weibo hot-search ranking. Use it to identify trending topics for newsroom monitoring, content planning, or timely topic discovery. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
justoneapi_get_api_weibo_search_all_v2Weibo Keyword Search API (V2)Inspect
Searches Weibo posts by keyword within a required day-and-hour time range, with page-based pagination, hot or time sorting, and filters for pictures, video, music, or links. Use it to find time-bounded posts for topic research or monitoring. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Search Keywords. | |
| page | No | Page number, starting with 1. | |
| endDay | Yes | End Day (yyyy-MM-dd). | |
| endHour | Yes | End Hour (0-23). | |
| hotSort | No | Hot sort, true for hot sort, false for time sort. Default is false. | |
| contains | No | Contains filter for the result set. Available Values: - `ALL`: All - `PICTURE`: Has Picture - `VIDEO`: Has Video - `MUSIC`: Has Music - `LINK`: Has Link | |
| startDay | Yes | Start Day (yyyy-MM-dd). | |
| startHour | Yes | Start Hour (0-23). |
justoneapi_get_api_weibo_search_profile_v1Weibo Search User Published Posts API (V1)Inspect
Searches posts published by a specific Weibo user, using a keyword, optional date range, and page-based pagination. Use it to find historical posts from a known account for topic research or campaign review. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Search Keywords. | |
| uid | Yes | Weibo User ID (UID). | |
| page | No | Page number, starting with 1. | |
| endDay | No | End Day (yyyy-MM-dd). | |
| startDay | No | Start Day (yyyy-MM-dd). |
justoneapi_get_api_weibo_tv_component_v1Weibo TV Video Details API (V1)Inspect
Retrieves Weibo TV video details for a colon-delimited object ID (OID). Use it to look up a known TV video for content review, cataloging, or downstream processing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| oid | Yes | Weibo video/object ID. |
justoneapi_get_api_weixin_channels_convert_export_id_v1WeChat Channels Export Id Conversion API (V1)Inspect
Converts an encrypted WeChat Channels export ID from search results into a usable video object identity. Use it to prepare the identifier required by video lookup endpoints. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| exportId | Yes | Encrypted WeChat Channels exportId returned by video search results. |
justoneapi_get_api_weixin_channels_get_bound_channel_v1WeChat Channels Get Bound Channel API (V1)Inspect
Finds the WeChat Channels account bound to a WeChat Official Account using either its original ID or an article URL. Use it to connect an official account with its Channels identity. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | WeChat Official Account article URL used to find the bound WeChat Channels account. Use either ghid or url. | |
| ghid | No | WeChat Official Account original id used to find the bound WeChat Channels account. Use either ghid or url. |
justoneapi_get_api_weixin_channels_get_video_basic_info_v1WeChat Channels Video Basic Info API (V1)Inspect
Resolves a copied WeChat Channels video link, preview URL, or short feed ID to basic video information. Use it to identify a shared Channels video before further lookups. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| feedInfo | Yes | WeChat Channels copied video link, finder-preview URL, or short feed id. |
justoneapi_get_api_weixin_channels_get_video_download_url_v1WeChat Channels Video Download URL API (V1)Inspect
Retrieves a downloadable media URL for a WeChat Channels video by object ID and optional nonce ID. Use it to download or play media from a known Channels video. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| objectId | Yes | WeChat Channels video object id used to fetch downloadable media links. | |
| objectNonceId | No | Optional WeChat Channels object nonce id. Supplying it can improve media lookup accuracy. |
justoneapi_get_api_weixin_channels_get_video_title_v1WeChat Channels Video Title API (V1)Inspect
Retrieves lightweight title information for a WeChat Channels video by object ID and optional nonce ID. Use it to identify known video content without requesting downloadable media. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| objectId | Yes | WeChat Channels video object id. | |
| objectNonceId | No | Optional WeChat Channels object nonce id. Supplying it can improve lookup accuracy. |
justoneapi_get_api_weixin_convert_article_link_v1WeChat Official Accounts Article Link Conversion API (V1)Inspect
Expands a WeChat Official Account article link to its resolved long-form destination. Use it to normalize a short or intermediate link before article lookup or collection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| link | Yes | WeChat Official Account article short link or intermediate link to convert. |
justoneapi_get_api_weixin_get_account_basic_info_v1WeChat Official Accounts Account Basic Info API (V1)Inspect
Retrieves basic profile information for a WeChat Official Account by account name. Use it to identify or enrich a known account before article, ownership, or publishing research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | WeChat Official Account name used to fetch basic profile information. |
justoneapi_get_api_weixin_get_account_original_count_v1WeChat Official Accounts Account Original Article Count API (V1)Inspect
Retrieves the original-article count for a WeChat Official Account identified by ghid or article URL. Use it to compare original publishing activity across known accounts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | WeChat Official Account article URL used to identify the account. Use either ghid or url. | |
| ghid | No | WeChat Official Account original identifier, using the gh_ prefix returned by WeChat. Use either ghid or url. |
justoneapi_get_api_weixin_get_account_principal_info_v1WeChat Official Accounts Account Principal Info API (V1)Inspect
Retrieves principal information for a WeChat Official Account identified by biz ID, article URL, or wxid. Use it to review the ownership or operating entity behind a known account. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| biz | No | WeChat Official Account biz id. Use one of biz, url, or wxid. | |
| url | No | WeChat Official Account article URL used to identify the account. Use one of biz, url, or wxid. | |
| wxid | No | WeChat Official Account wxid used to identify the account. Use one of biz, url, or wxid. |
justoneapi_get_api_weixin_get_article_detail_v1WeChat Official Accounts Article Details API (V1)Inspect
Retrieves a WeChat Official Account article by URL with selectable plain-text or rich-text content mode. Use it to collect a known article in the preferred representation for reading, extraction, or storage. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Article body format. TEXT returns plain text, and RICH_TEXT returns rich text when supported. Available Values: - `TEXT`: Plain text article detail - `RICH_TEXT`: Rich text article detail | |
| articleUrl | Yes | WeChat Official Account article URL used to fetch article detail content and metadata. |
justoneapi_get_api_weixin_get_article_detail_v2WeChat Official Accounts Article Details API (V2)Inspect
Retrieves structured details for a WeChat Official Account article by URL. Use it to collect a known article for parsing, indexing, or structured content archiving. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| articleUrl | Yes | WeChat Official Account article URL used to fetch structured article detail fields and an HTML content fragment. |
justoneapi_get_api_weixin_get_article_detail_v3WeChat Official Accounts Article Details API (V3)Inspect
Retrieves details for a WeChat Official Account article that may include video content, with selectable plain-text or rich-text mode. Use it to process known articles containing video material. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Article body format. TEXT returns plain text, and RICH_TEXT returns rich text when supported. Available Values: - `TEXT`: Plain text article detail - `RICH_TEXT`: Rich text article detail | |
| articleUrl | Yes | WeChat Official Account article URL used to fetch article details with video-related fields when available. |
justoneapi_get_api_weixin_get_article_detail_v4WeChat Official Accounts Article Details API (V4)Inspect
Retrieves an HTML representation of a WeChat Official Account article by URL. Use it to preserve, render, or archive a known article as a web document. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| articleUrl | Yes | WeChat Official Account article URL used to fetch a full HTML document for rendering or archiving. |
justoneapi_get_api_weixin_get_article_detail_v5WeChat Official Accounts Article Details API (V5)Inspect
Retrieves lightweight information for a WeChat Official Account article by URL. Use it to perform a quick article lookup before deeper content, metric, or comment retrieval. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| articleUrl | Yes | WeChat Official Account article URL used to fetch lightweight article metadata and status information. |
justoneapi_get_api_weixin_get_article_metrics_v1WeChat Official Accounts Article Metrics API (V1)Inspect
Retrieves basic interaction metrics for a WeChat Official Account article URL that ends with #rd or #wechat_redirect. Use it to perform a lightweight popularity check for a known article. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| articleUrl | Yes | WeChat Official Account article URL used to fetch basic interaction metrics such as reads and likes. It must end with #rd or #wechat_redirect. |
justoneapi_get_api_weixin_get_article_metrics_v2WeChat Official Accounts Article Metrics API (V2)Inspect
Retrieves extended interaction metrics for a WeChat Official Account article by URL. Use it to compare article performance or support deeper engagement analysis for known content. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| articleUrl | Yes | WeChat Official Account article URL used to fetch extended interaction and article performance metrics. |
justoneapi_get_api_weixin_get_article_sub_comment_v1WeChat Official Accounts Article Comment Replies API (V1)Inspect
Retrieves replies under a top-level comment for a WeChat Official Account article, identified by article URL and contentId. Use it to inspect threaded discussion beneath a known comment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| contentId | Yes | Top-level comment content id used to fetch nested comment replies. | |
| articleUrl | Yes | WeChat Official Account article URL used to fetch replies under a top-level comment. |
justoneapi_get_api_weixin_search_suggestions_v1WeChat Official Accounts Search Suggestions API (V1)Inspect
Retrieves WeChat search suggestions for a keyword, optionally scoped by a supported business type. Use it to expand or refine a query before a targeted WeChat search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Keyword used to fetch WeChat search suggestions. | |
| businessType | No | WeChat search business type used to scope suggestion results. Available Values: - `ALL`: All - `ACCOUNT`: Official accounts - `ARTICLE`: Articles - `CHANNEL`: Channels - `MOMENTS`: Moments - `LIVE`: Live - `EMOJI`: Emoji - `AUDIO`: Audio - `BOOK`: Books - `WECHAT_INDEX`: WeChat index - `NEWS`: News - `MINI_PROGRAM`: Mini programs - `ENCYCLOPEDIA`: Encyclopedia |
justoneapi_get_api_weixin_search_wechat_index_v1WeChat Official Accounts WeChat Index Search API (V1)Inspect
Queries WeChat Index for a keyword. Use it to examine trend interest within WeChat before planning content, campaigns, or further article research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Keyword used to query WeChat Index trend signals. |
justoneapi_get_api_xianyu_get_item_detail_v1Xianyu (GooFish) Product Details API (V1)Inspect
Retrieves the public detail for a Xianyu (GooFish) second-hand listing by item ID. Use it to inspect a known resale item after search or link discovery. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | A unique product identifier on Xianyu. |
justoneapi_get_api_xianyu_search_item_list_v1Xianyu (GooFish) Product Search API (V1)Inspect
Searches Xianyu (GooFish) second-hand listings by keyword with page and sort controls. Use it to discover resale items by activity, recency, seller credit, price, or listing time. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. The first page is 1. | |
| sort | No | Sort order for Xianyu search results. Available Values: - `active`: Active listings first. - `recent`: Recent nearby or position-based results first. - `credit`: Seller credit first. - `price_asc`: Lowest price first. - `price_desc`: Highest price first. - `price_drop`: Reduced-price listings first. - `newest`: Newly listed items first. | |
| keyword | Yes | Search keyword. |
justoneapi_get_api_xiaohongshu_ask_dotsXiaohongshu (RedNote) Ask Dots AI APIInspect
Queries Xiaohongshu (RedNote) Ask Dots AI with a keyword question. Use it to retrieve an AI answer for topic research and question exploration. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Question or keyword to submit to Ask Dots AI. |
justoneapi_get_api_xiaohongshu_ec_search_products_v1Xiaohongshu E-commerce (RedNote) Product Search API (V1)Inspect
Searches Xiaohongshu E-commerce (RedNote) products by keyword with page and search-ID pagination; pages after the first require the search ID returned by the initial search. Use it to discover marketplace products and continue through multi-page results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting from 1. | |
| keyword | Yes | Search keyword. | |
| searchId | No | Search ID returned by the first-page response; required when page is greater than 1. |
justoneapi_get_api_xiaohongshu_get_creator_hot_inspiration_feedXiaohongshu (RedNote) Hot Inspiration Feed API (V1)Inspect
Retrieves the Xiaohongshu (RedNote) creator center hot inspiration feed with cursor pagination. Use it to discover inspiration for content planning and explore further pages of creative ideas. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Leave empty for the first request. For the next page, pass the cursor value returned by the previous response. |
justoneapi_get_api_xiaohongshu_get_note_comment_v2Xiaohongshu (RedNote) Note Comments API (V2)Inspect
Retrieves comments for a Xiaohongshu (RedNote) note with cursor pagination and normal, latest, or like-count sorting. Use it to support feedback review, discussion analysis, and comment moderation workflows. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort strategy for the result set. Available Values: - `normal`: Normal - `latest`: Latest - `like_count`: Like Count | |
| noteId | Yes | A Xiaohongshu note ID or an explore URL containing /explore/. | |
| lastCursor | No | Pagination cursor from the previous page (use the cursor value returned by the last response). |
justoneapi_get_api_xiaohongshu_get_note_detail_v1Xiaohongshu (RedNote) Note Details API (V1)Inspect
Retrieves Xiaohongshu (RedNote) details for a note identified by a note ID or supported explore URL. Use it to perform direct note lookup and content review from stored identifiers or shared explore links. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | A Xiaohongshu note ID or an explore URL containing /explore/. |
justoneapi_get_api_xiaohongshu_get_note_detail_v6Xiaohongshu (RedNote) Note Details API (V6)Inspect
Retrieves Xiaohongshu (RedNote) video-note details by note ID. Use it to look up and process a known video note. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Unique note identifier on Xiaohongshu. |
justoneapi_get_api_xiaohongshu_get_note_sub_comment_v2Xiaohongshu (RedNote) Comment Replies API (V2)Inspect
Retrieves replies to a specific Xiaohongshu (RedNote) note comment with cursor pagination. Use it to inspect threaded discussions and continue through reply pages for feedback review or moderation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Unique note identifier on Xiaohongshu. | |
| commentId | Yes | Unique comment identifier on Xiaohongshu. | |
| lastCursor | No | Pagination cursor from the previous page (use the cursor value returned by the last response). |
justoneapi_get_api_xiaohongshu_get_topic_note_list_v1Xiaohongshu (RedNote) Topic Note List API (V1)Inspect
Retrieves Xiaohongshu (RedNote) notes associated with a topic ID, with hot or latest sorting and cursor pagination. Use it to support topic content discovery, trend review, and continuing through topic result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for the result set. Available Values: - `time`: Latest - `hot`: Hot | |
| cursor | No | Pagination cursor from the previous page. | |
| topicId | Yes | Unique topic identifier on Xiaohongshu. |
justoneapi_get_api_xiaohongshu_get_user_faved_note_list_v1Xiaohongshu (RedNote) User Favorited Notes API (V1)Inspect
Retrieves a Xiaohongshu (RedNote) user's favorited notes by user ID with cursor pagination. Use it to review a user's saved content and research content interests. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | Unique user identifier on Xiaohongshu. | |
| lastCursor | No | For the next page, pass the cursor from the previous response. Omit or pass an empty value for the first page. |
justoneapi_get_api_xiaohongshu_get_user_note_list_v4Xiaohongshu (RedNote) User Notes API (V4)Inspect
Reads a user's published public Xiaohongshu (RedNote) notes by user ID or supported profile URL, with lastCursor pagination. This endpoint does not create, upload or publish notes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | A Xiaohongshu user ID or a profile URL containing /user/profile/. | |
| lastCursor | No | Omit on the first request. For the next page, pass the last note's cursor value from the previous response. |
justoneapi_get_api_xiaohongshu_get_user_v3Xiaohongshu (RedNote) User Profile API (V3)Inspect
Retrieves a Xiaohongshu (RedNote) user profile from a user ID or supported profile URL. Use it to support creator discovery, account research, and reviewing a known profile before related content analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | A Xiaohongshu user ID or a profile URL containing /user/profile/. |
justoneapi_get_api_xiaohongshu_hot_search_v1Xiaohongshu (RedNote) Hot Search API (V1)Inspect
Searches Xiaohongshu (RedNote) hot-content entries with optional keyword, content-category path, pagination, ranking metric, and time-range controls. Use it to support trend discovery, topic monitoring, and content planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| nd | No | Time range in days. Available Values: - `DAY_3`: Last 3 days - `DAY_7`: Last 7 days - `DAY_14`: Last 14 days - `DAY_30`: Last 30 days | |
| orderBy | No | Sort metric for the result set. Available Values: - `premium_imp_num`: Exposure - `premium_good_read_rate`: Read rate - `premium_read_num`: Read count - `premium_engage_num`: Engagement count - `premium_engage_rate`: Engagement rate - `premium_like_num`: Like count - `premium_fav_num`: Favorite count - `premium_cmt_num`: Comment count | |
| pageNum | No | Page number for pagination. | |
| searchWord | No | Search keyword. | |
| noteContentCategory | No | Content category filter. Pass one complete Pugongying category path joined with # separators. A parent path may be submitted alone, or one listed child may be appended with another #. Only one path is accepted. The first segment must be the provider's exact native root for either content categories or industry categories. Content topics include beauty, parenting, fashion, food, home, entertainment, fitness, pets, arts, education, careers, relationships, photography, gaming, technology, travel, music, automotive, weddings, finance, and creative assets. Industry topics include parenting, appliances, electronics, food, personal care, automotive/transport, local services, household products, health, pets, home, travel, education, finance, medical/aesthetic services, duty-free retail, clothing, jewelry, sports, leisure, luxury, online services, photography/weddings, and real estate. Use exact native root/parent/child tokens from the provider reference; translated English names must not replace request path tokens. Original accepted labels and paths: https://docs.justoneapi.com/openapi/xiaohongshu-rednote/hot-search-v1-zh.json |
justoneapi_get_api_xiaohongshu_pgy_api_pgy_content_square_searchXiaohongshu Creator Marketplace (Pugongying) Content Square Notes API (V1)Inspect
Search Xiaohongshu Pugongying Content Square notes by keyword or browse all notes, with business-category, ranking, time-window, and page controls. Use it to discover high-performing campaign content. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| nd | No | Time range in days. Available Values: - `DAY_3`: Last 3 days - `DAY_7`: Last 7 days - `DAY_14`: Last 14 days - `DAY_30`: Last 30 days | |
| bizType | No | Business category. Available Values: - `XIAOHONGSHU_HOT`: Xiaohongshu hot - `PRODUCT_SEEDING`: Product seeding - `ECOMMERCE_PROMOTION`: E-commerce promotion - `PUGONGYING_COOPERATION`: Pugongying cooperation - `LEAD_COLLECTION`: Lead collection - `ECOMMERCE_HOT`: E-commerce hot - `SEEDING_DIRECT`: Seeding direct - `APP_PROMOTION`: App promotion | |
| orderBy | No | Ranking metric. Available Values: - `premium_imp_num`: Exposure - `premium_good_read_rate`: Read rate - `premium_read_num`: Read count - `premium_engage_num`: Engagement count - `premium_engage_rate`: Engagement rate - `premium_like_num`: Like count - `premium_fav_num`: Favorite count - `premium_cmt_num`: Comment count | |
| pageNum | No | Page number for results. | |
| searchWord | No | Keyword for note search. Empty string searches all notes. |
justoneapi_get_api_xiaohongshu_pgy_api_pgy_kol_data_core_data_v1Xiaohongshu Creator Marketplace (Pugongying) Creator Core Metrics API (V1)Inspect
Retrieves Xiaohongshu Pugongying core data for a creator with business, note-type, date-range, and advertisement filters. Use it to compare creators within a selected analysis scope. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. | |
| business | No | Business type. Available Values: - `DAILY_NOTE`: Daily notes - `COOPERATE_NOTE`: Cooperative notes | |
| dateType | No | Time range for data. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| noteType | No | Type of note. Available Values: - `PHOTO_TEXT_AND_VIDEO`: Photo and Video - `PHOTO_TEXT`: Photo and Text - `VIDEO`: Video only | |
| advertiseSwitch | No | Advertisement filter. Available Values: - `ALL`: All notes - `ORGANIC_ONLY`: Organic notes only |
justoneapi_get_api_xiaohongshu_pgy_api_solar_cooperator_bloggerXiaohongshu Creator Marketplace (Pugongying) Creator Search API (V1)Inspect
Search Xiaohongshu Pugongying creators with campaign filters and sorting by followers, daily-note median reads or interactions, or quoted price. Use it to build a creator shortlist. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. | |
| sort | No | Creator search sorting. Values: FANS sorts by follower count descending; DEFAULT uses Pugongying intelligent ranking; READ_MEDIAN sorts by daily-note median reads descending; ENGAGEMENT_MEDIAN sorts by daily-note median interactions descending; PRICE_ASC sorts by all quoted prices ascending; PRICE_DESC sorts by all quoted prices descending. Defaults to FANS. Available Values: - `DEFAULT`: Platform default intelligent ranking - `FANS`: Sort by follower count descending - `READ_MEDIAN`: Sort by daily-note median reads descending - `ENGAGEMENT_MEDIAN`: Sort by daily-note median interactions descending - `PRICE_ASC`: Sort by all quoted prices ascending - `PRICE_DESC`: Sort by all quoted prices descending | |
| gender | No | KOL's gender. Available Values: - `ALL`: All genders - `MALE`: Male - `FEMALE`: Female | |
| fansAge | No | Target fans age group. Available Values: - `ALL`: All ages - `LT_18`: Under 18 - `AGE_18_24`: 18 to 24 - `AGE_25_34`: 25 to 34 - `AGE_35_44`: 35 to 44 - `GT_44`: Above 44 | |
| keyword | No | Search keyword. | |
| industry | No | Pugongying industry preset for industry assistant style creator recommendations. Use the enum values in this parameter. Full value descriptions: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-search-v1-zh.json | |
| location | No | Creator profile location filter. Pass Pugongying native location labels separated by English or Chinese commas. Country, China province/region, city-level paths, and district/county-level paths are supported. Short province/region labels are normalized to their full Pugongying values. Only paths in the Pugongying location tree are accepted. Both shorter native paths and country-prefixed native paths can be normalized; for example, a country/province/city/district path for China, Shanxi, Changzhi, and Luzhou district. Use exact native labels from the original reference, not these English explanations. Original accepted labels and paths: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-search-v1-zh.json | |
| noteType | No | Note type filter. Values: ALL=all note types, PHOTO_TEXT=mainly photo-text notes, VIDEO=mainly video notes. Available Values: - `ALL`: All note types - `PHOTO_TEXT`: Mainly photo-text notes - `VIDEO`: Mainly video notes | |
| fansNumUp | No | Whether to exclude bloggers whose fan count is dropping. | |
| notePrice | No | Photo-text cooperation quote range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound. | |
| tradeType | No | Recent cooperation industry filter from Pugongying. | |
| avgAgmv90d | No | Average live sales amount range. Pass two comma-separated numeric bounds. | |
| contentTag | No | Content category filter. Pass Pugongying first-level or second-level category labels separated by commas. Categories cover makeup, skin care, personal care, parenting, fashion, food, home and renovation, film/TV/entertainment, fitness, pets, culture and arts, hobbies, daily life, education, relationships, photography, gaming, technology, transport and travel, music, comedy, wellness, automotive, weddings, business and finance, creative assets, and other topics. Use exact native parent or child labels from the provider reference; English category descriptions are not accepted replacement labels. Original accepted labels and paths: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-search-v1-zh.json | |
| fansGender | No | Target fans gender. Available Values: - `ALL`: All genders - `MALE_HIGH`: Mainly Male - `FE_MALE_HIGH`: Mainly Female | |
| searchType | No | Search criteria type. Available Values: - `NICKNAME`: Search by nickname - `NOTE`: Search by note content | |
| videoPrice | No | Video cooperation quote range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound. | |
| featureTags | No | Good-at content tag filter. Pass label values separated by commas. | |
| kliveCnt30d | No | Live count in the last 30 days range. Pass two comma-separated numeric bounds. | |
| mCpuvNum30d | No | Cooperation note outer-store median range. Pass two comma-separated numeric bounds. | |
| similarWord | No | Similar creator keyword shown by Pugongying. `similarUserId` and `similarWord` must be provided together. | |
| fansLocation | No | Follower audience location filter. Pass Pugongying native follower-region labels separated by English or Chinese commas. Country, China province, and city-level paths are supported; district/county-level paths are not accepted. Only paths in the provider's follower-region tree are accepted. Native province/city paths may use spaces or hyphens and can include the country prefix; they are normalized to the provider's full native country/province/city path. For example, use the exact native labels for Fujian and Nanping. English place names here are explanations, not substitute request values. Original accepted labels and paths: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-search-v1-zh.json | |
| marketTarget | No | Marketing target filter. Pass one Pugongying marketing target value. Available values: - estimateAllCpm: Exposure - exposure performance - cost - mAccumImpNum: Exposure - exposure performance - scale - readCost: Exposure - read performance - cost - mValidRawReadFeedNum: Exposure - read performance - scale - estimateEngageCost: Seeding - engagement performance - cost - mEngagementNum90d: Seeding - engagement performance - scale - estimateCpuv: Conversion - outer-store visit performance - cost - mCpuvNum: Conversion - outer-store visit performance - scale | |
| personalTags | No | Blogger persona filter. Pass one or more Pugongying native persona labels separated by English or Chinese commas. Labels describe family roles, couples and friends, pregnancy/parenting stages, people over 12, industries and occupations, education and overseas-study backgrounds, personal experience and interests, pet owners, people living alone, overseas Chinese, foreigners, and people of mixed ancestry. Examples of meanings include mother, coach, athlete, dance teacher, and overseas-study background. Submit exact native labels from the provider reference, not these English explanations. Original accepted labels and paths: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-search-v1-zh.json | |
| readMidNor30 | No | Daily note read median range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound. | |
| audienceGroup | No | Audience target filter. Pass Pugongying audience group IDs (`dmpGroupId`) separated by English or Chinese commas. These IDs are dynamic and account-specific, so there is no fixed global value list. Use the audience group name shown in Pugongying Audience Management to identify what each ID means. | |
| interMidNor30 | No | Daily note interaction median range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound. | |
| readMidCoop30 | No | Cooperation note read median range. Pass two comma-separated numeric bounds. | |
| similarUserId | No | Similar creator user ID. `similarUserId` and `similarWord` must be provided together. | |
| interMidCoop30 | No | Cooperation note interaction median range. Pass two comma-separated numeric bounds. | |
| estimateCpuv30d | No | Estimated outer-store visit unit price range. Pass two comma-separated numeric bounds. | |
| fansNumberLower | No | Minimum number of fans. | |
| fansNumberUpper | No | Maximum number of fans. | |
| avgLiveViewerNum | No | Average live viewer count range. Pass two comma-separated numeric bounds. | |
| estimateVideoCpm | No | Estimated video CPM range. Pass two comma-separated numeric bounds. | |
| excludeLowActive | No | Whether to exclude low-activity bloggers. | |
| fansChildAgeInfo | No | Mother-and-baby audience stage filter. Pass Pugongying labels or numeric codes, separated by English or Chinese commas. Numeric codes: 1 = preparing for pregnancy; 2 = 0-6 months; 3 = 7-12 months; 4 = 1-3 years; 5 = 4-6 years; 6 = 7-12 years; 7 = early pregnancy; 8 = late pregnancy. If sending labels instead of codes, use the provider's original native labels. Original accepted labels and paths: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-search-v1-zh.json | |
| progressOrderCnt | No | Current cooperation order count range. Pass two comma-separated numeric bounds. | |
| top20CrowdsLabel | No | Top-20 audience filter. Pass top-level or child audience labels separated by commas; child labels are converted to Pugongying request values. | |
| contentSceneLabel | No | Content scene filter. Pass complete Pugongying note-category scene-label paths separated by English or Chinese commas. Preserve the full path, its word order, spaces, separators, and native labels; do not send an isolated leaf or an English translation. The source table includes automotive purchase decisions, vehicle-use scenarios, vehicle personalization/types/communities/brands/energy and life stages; game platforms, genres, and titles; and parenting product/use-case paths. The complete original list is retained in the linked parameter reference and the candidate's native contract. Original accepted labels and paths: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-search-v1-zh.json | |
| contentThemeLabel | No | Content theme filter. Pass Pugongying value IDs or label values separated by commas; labels are converted to value IDs. | |
| estimatePictureCpm | No | Estimated photo-text CPM range. Pass two comma-separated numeric bounds. | |
| tradeReportBrandIds | No | Recent cooperation brand IDs, separated by English or Chinese commas. | |
| estimatePicReadPrice | No | Estimated photo-text read unit price range. Pass two comma-separated numeric bounds. | |
| thousandLikePercent30 | No | Thousand-like note ratio range. Pass fractional ratios such as 0.4,null or percentage values such as 40,null. | |
| estimateVideoReadPrice | No | Estimated video read unit price range. Pass two comma-separated numeric bounds. | |
| inviteReply48hNumRatio | No | 48-hour invite reply ratio range. Pass fractional ratios such as 0.9,0.95 or percentage values such as 90,95. | |
| accumCoopImpMedinNum30d | No | Cooperation note exposure median range. Pass two comma-separated numeric bounds. | |
| estimateVideoEngageCost | No | Estimated video engagement unit price range. Pass two comma-separated numeric bounds. | |
| accumCommonImpMedinNum30d | No | Daily note exposure median range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound. | |
| estimatePictureEngageCost | No | Estimated photo-text engagement unit price range. Pass two comma-separated numeric bounds. | |
| excludeTradeReportBrandIds | No | Whether to exclude creators who cooperated with the selected recent cooperation brands. | |
| industrySpecificCrowdsMotorDom | No | Industry-specific portrait filter. Pass Pugongying portrait value IDs or label values separated by commas. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_cooperator_user_bloXiaohongshu Creator Marketplace (Pugongying) Creator Profile API (V1)Inspect
Retrieve a Xiaohongshu Pugongying creator profile and cooperation quote information for a known user ID. Use it to review a creator before campaign outreach or pricing comparison. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | Blogger's user ID. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_data_userid_f_2Xiaohongshu Creator Marketplace (Pugongying) Follower Growth History API (V1)Inspect
Retrieve Xiaohongshu Pugongying follower history for a creator over the selected 30- or 90-day period. Use it to track total followers or new-follower growth over time. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. | |
| dateType | No | Time range for data. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| increaseType | No | Type of growth data. Available Values: - `FANS_TOTAL`: Total fans - `FANS_INCREASE`: New fans increase |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_data_userid_fanXiaohongshu Creator Marketplace (Pugongying) Follower Distribution API (V1)Inspect
Retrieves Xiaohongshu Pugongying follower profile data for a known creator. Use it to review a creator's audience profile during campaign planning. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_costeffeXiaohongshu Creator Marketplace (Pugongying) Cost Effectiveness Analysis API (V1)Inspect
Retrieve the Xiaohongshu Pugongying cost-effectiveness analysis for a known creator. Use it to assess cooperation efficiency when comparing creators for a campaign. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_kolconteXiaohongshu Creator Marketplace (Pugongying) Creator Content Tags API (V1)Inspect
Retrieve Xiaohongshu Pugongying content category tags associated with a known creator. Use it to understand the subjects and categories represented in the creator's published content. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_kolfeatuXiaohongshu Creator Marketplace (Pugongying) Creator Feature Tags API (V1)Inspect
Retrieve Xiaohongshu Pugongying feature tags assigned to a known creator. Use it to understand the creator's recognized formats, styles, or content strengths. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_notesdetXiaohongshu Creator Marketplace (Pugongying) Creator Note List API (V1)Inspect
Retrieve a paginated Xiaohongshu Pugongying creator note list with advertisement, sort-order, note-type, and third-platform filters. Use it to browse selected content from a known creator. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. | |
| noteType | No | Type of note. Available Values: - `ALL`: All types - `COOPERATION`: Cooperation notes - `PHOTO_TEXT`: Photo and Text - `VIDEO`: Video only | |
| orderType | No | Sorting order. Available Values: - `LATEST`: Latest - `MOST_READ`: Most read - `MOST_INTERACT`: Most interactions | |
| pageNumber | No | Page number. | |
| advertiseSwitch | No | Advertisement filter. Available Values: - `ALL`: All notes - `ORGANIC_ONLY`: Organic notes only | |
| isThirdPlatform | No | Whether from third-party platform. Available Values: - `NO`: No - `YES`: Yes |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav3_datasummXiaohongshu Creator Marketplace (Pugongying) Data Summary API (V1)Inspect
Retrieve the Xiaohongshu Pugongying data summary for a creator's daily or cooperation notes. Use it to compare aggregate creator performance between business modes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. | |
| business | No | Business type. Available Values: - `DAILY_NOTE`: Daily notes - `COOPERATE_NOTE`: Cooperative notes |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav3_fanssummXiaohongshu Creator Marketplace (Pugongying) Follower Summary API (V1)Inspect
Retrieve the Xiaohongshu Pugongying follower summary for a known creator. Use it to review the account's aggregate audience status before deeper demographic or trend analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav3_notesratXiaohongshu Creator Marketplace (Pugongying) Note Performance Metrics API (V1)Inspect
Retrieve Xiaohongshu Pugongying aggregate note performance metrics for a creator with business, note-type, date-range, and advertisement filters. Use it to compare content performance across selected scopes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. | |
| business | No | Business type. Available Values: - `DAILY_NOTE`: Daily notes - `COOPERATE_NOTE`: Cooperative notes | |
| dateType | No | Time range for data. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days | |
| noteType | No | Type of note. Available Values: - `PHOTO_TEXT_AND_VIDEO`: Photo and Video - `PHOTO_TEXT`: Photo and Text - `VIDEO`: Video only | |
| advertiseSwitch | No | Advertisement filter. Available Values: - `ALL`: All notes - `ORGANIC_ONLY`: Organic notes only |
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_get_similar_kolXiaohongshu Creator Marketplace (Pugongying) Similar Creators API (V1)Inspect
Retrieve paginated Xiaohongshu Pugongying creators similar to a known creator. Use it to expand a campaign shortlist from an existing reference account. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | KOL's user ID. | |
| pageNum | No | Page number for results. |
justoneapi_get_api_xiaohongshu_pgy_api_solar_note_noteid_detailXiaohongshu Creator Marketplace (Pugongying) Note Details API (V1)Inspect
Retrieves Xiaohongshu Pugongying details for a known note ID. Use it to review an individual note during creator or campaign research. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Note's unique ID. |
justoneapi_get_api_xiaohongshu_pgy_get_kol_note_list_v1Xiaohongshu Creator Marketplace (Pugongying) Creator Note List Pro API (V1)Inspect
Retrieve a paginated Xiaohongshu Pugongying creator note list with advertisement, sort-order, and note-type controls. Use it to browse a creator's recent, most-read, or most-interacted notes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. | |
| kolId | Yes | KOL ID. | |
| adSwitch | Yes | Ad filter. Available Values: - `_1`: Full traffic (All notes) - `_0`: Natural traffic (Organic notes) | |
| noteType | No | Note type. Available Values: - `_1`: Photo and Text notes - `_2`: Video notes - `_3`: Cooperation notes - `_4`: All types | |
| orderType | Yes | Sorting order. Available Values: - `_1`: Latest - `_2`: Most read - `_3`: Most interactions |
justoneapi_get_api_xiaohongshu_search_note_v2Xiaohongshu (RedNote) Keyword Note Search API (V2)Inspect
Searches Xiaohongshu (RedNote) notes by keyword with page-based pagination, sorting and note-type filters. The V2 noteTime filter may return notes outside the selected time range. This endpoint does not search user accounts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. Start at 1, then increment page while keeping the keyword and filters unchanged. | |
| sort | No | Sort order for the result set. Available Values: - `general`: General - `popularity_descending`: Popularity Descending - `time_descending`: Time Descending - `comment_descending`: Comment Descending - `collect_descending`: Collect Descending | |
| keyword | Yes | Search keyword. | |
| noteTime | No | Note publish time filter. Results may include notes published outside the selected time range. Available Values: - `ONE_DAY`: Within one day - `ONE_WEEK`: Within a week - `HALF_YEAR`: Within half a year | |
| noteType | No | Note type filter. Available Values: - `_0`: General - `_1`: Video - `_2`: Normal |
justoneapi_get_api_xiaohongshu_search_note_v4Xiaohongshu (RedNote) Note Search API (V4)Inspect
Searches Xiaohongshu (RedNote) notes through the mobile-app search flow with pagination, sorting, note-type, and time filters. Use it to support iterative topic research and filtered content discovery. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| keyword | Yes | Search keyword. | |
| noteType | No | Note type filter. Available Values: - `ALL`: No Limit - `VIDEO_NOTE`: Video Note - `NORMAL_NOTE`: Normal Note | |
| sortType | No | Sort order for the result set. Available Values: - `general`: General - `popularity_descending`: Popularity Descending - `time_descending`: Time Descending - `comment_descending`: Comment Descending - `collect_descending`: Collect Descending | |
| timeFilter | No | Publish time filter. Available Values: - `ALL`: No Limit - `ONE_DAY`: Within one day - `ONE_WEEK`: Within one week - `HALF_YEAR`: Within half a year |
justoneapi_get_api_xiaohongshu_search_recommend_v1Xiaohongshu (RedNote) Keyword Suggestions API (V1)Inspect
Returns Xiaohongshu (RedNote) search keyword suggestions for a submitted seed term. Use it to expand query sets, refine content-research searches, and plan SEO or programmatic SEO keyword coverage. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Search keyword. |
justoneapi_get_api_xiaohongshu_search_user_v2Xiaohongshu (RedNote) User Search API (V2)Inspect
Searches Xiaohongshu (RedNote) users by keyword with page-based pagination. Use it to support creator discovery, account research, and finding profiles related to a topic, name, or brand term. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| keyword | Yes | Search keyword. |
justoneapi_get_api_youku_get_user_detail_v1YOUKU User Profile API (V1)Inspect
Retrieves a Youku user profile identified by UID. Use it to look up a known account for creator research, profile review, or related video discovery. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | The unique identifier for the user. |
justoneapi_get_api_youku_get_video_detail_v1YOUKU Video Details API (V1)Inspect
Retrieves details for a Youku video identified by video ID. Use it to look up a known video for content review, cataloging, or subsequent video analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| videoId | Yes | The unique identifier for the video. |
justoneapi_get_api_youku_search_video_v1YOUKU Video Search API (V1)Inspect
Searches Youku videos by keyword with page-based pagination. Use it to discover videos related to a topic, title, creator, or other search term. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination, starting from 1. | |
| keyword | Yes | Keyword to search for. |
justoneapi_get_api_youtube_get_channel_shorts_v1YouTube Channel Shorts API (V1)Inspect
Retrieve public Shorts from a YouTube channel ID with optional continuation-token pagination. Use it to browse a channel's short-form videos and continue through additional result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channelId | Yes | The UC-prefixed unique identifier for a YouTube channel. @username handles are not supported. | |
| continuationToken | No | Pagination token returned by the previous response. |
justoneapi_get_api_youtube_get_channel_videos_v1YouTube Channel Videos API (V1)Inspect
Retrieve public videos from a YouTube channel, with optional cursor-based pagination. Use it to browse a channel's uploads and continue through additional result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | The cursor for pagination. | |
| channelId | Yes | The unique identifier for a YouTube channel. |
justoneapi_get_api_youtube_get_video_captions_v1YouTube Video Captions API (V1)Inspect
Retrieve available caption tracks for a YouTube video or request captions in SRT, XML, JSON3, or plain-text format. Use it to support transcription, accessibility, localization, or text analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Caption output format. Available Values: - `srt`: SubRip caption format with timeline cues - `xml`: Original XML caption format - `json3`: YouTube original JSON caption structure - `txt`: Plain text without timeline cues | |
| videoId | Yes | The unique identifier for a YouTube video. | |
| languageCode | No | Caption language code, such as en, zh-Hans, or a.en. Leave it empty to retrieve available caption tracks. |
justoneapi_get_api_youtube_get_video_comment_v1YouTube Video Comment List API (V1)Inspect
Retrieve first-level comments for a YouTube video with sorting, locale options, and cursor pagination. Use it to review audience discussion or continue through additional comment pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor returned by the previous response. | |
| sortBy | No | Sort order for the comment list. Available Values: - `top`: Top comments - `newest`: Newest comments | |
| videoId | Yes | The unique identifier for a YouTube video. | |
| countryCode | No | Region code for response data. | |
| languageCode | No | Language preference for response data. |
justoneapi_get_api_youtube_get_video_detail_v1YouTube Video Details API (V1)Inspect
Retrieve public details for a YouTube video identified by video ID. Use it to inspect a known video before further content or comment analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Optional IETF language tag for localized video details, such as en-US. Leave empty to use the default language. | |
| videoId | Yes | The unique identifier for a YouTube video. |
justoneapi_get_api_youtube_get_video_sub_comment_v1YouTube Video Sub Comment List API (V1)Inspect
Retrieve replies associated with a YouTube comment continuation cursor, with optional locale settings. Use it to follow threaded discussion beyond first-level comments. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | Yes | Reply cursor from a first-level comment response. | |
| countryCode | No | Region code for response data. | |
| languageCode | No | Language preference for response data. |
justoneapi_get_api_youtube_search_v1YouTube General Search API (V1)Inspect
Search YouTube videos by keyword with optional language, upload-date, duration, and sort filters, or continue with a pagination token. Use it to discover public videos or browse additional result pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Optional IETF language tag for localized results, such as en-US. Leave empty to use the default language. | |
| sortBy | No | Sort order for search results. Available Values: - `relevance`: Sort by relevance - `uploadDate`: Sort by upload date - `viewCount`: Sort by view count - `rating`: Sort by rating | |
| keyword | No | Search term. Required for the first page; leave empty when using nextToken. | |
| duration | No | Video-duration filter. Available Values: - `all`: No duration limit - `short`: Short videos under 4 minutes - `medium`: Medium videos from 4 to 20 minutes - `long`: Long videos over 20 minutes | |
| nextToken | No | Pagination token returned by the previous response. When provided, the keyword and filter parameters are ignored; very long tokens may exceed GET URL limits. | |
| uploadDate | No | Upload-date filter. Available Values: - `all`: No upload-date limit - `lastHour`: Uploaded within the last hour - `today`: Uploaded today - `thisWeek`: Uploaded this week - `thisMonth`: Uploaded this month - `thisYear`: Uploaded this year |
justoneapi_get_api_zhihu_get_answer_comments_v1Zhihu Answer Comments API (V1)Inspect
Retrieve comments for a Zhihu answer with hottest or latest sorting and offset pagination. Use it to review discussion around a known answer and continue through additional comment pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Pagination offset from the previous result. | |
| orderBy | No | Sorting order for comments. Available Values: - `score`: Sort by highest score. - `ts`: Sort by latest time. | |
| answerId | Yes | Answer ID |
justoneapi_get_api_zhihu_get_answer_list_v1Zhihu Answer List API (V1)Inspect
Retrieve answers for a Zhihu question with sorting and pagination controls. Use it to browse responses to a known question and continue through additional answer pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order | No | Sorting criteria for answers. Available Values: - `_default`: Default sorting. - `_updated`: Sorted by updated time. | |
| cursor | No | Pagination cursor from previous result. | |
| offset | No | Start offset, begins with 0. | |
| sessionId | No | Session ID from previous result. | |
| questionId | Yes | Question ID |
justoneapi_get_api_zhihu_get_column_article_detail_v1Zhihu Column Article Details API (V1)Inspect
Retrieve details for a Zhihu column article identified by article ID. Use it to inspect a known article for reading, review, or archiving. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Article ID |
justoneapi_get_api_zhihu_get_column_article_list_v1Zhihu Column Article List API (V1)Inspect
Retrieve articles from a Zhihu column with offset pagination. Use it to browse a known column's publication history and select articles for detail lookup. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| columnId | Yes | Column ID |
justoneapi_get_api_zhihu_get_comment_replies_v1Zhihu Comment Replies API (V1)Inspect
Retrieve replies to a Zhihu comment with hottest or latest sorting and offset pagination. Use it to follow discussion under a known comment and continue through additional reply pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Pagination offset from the previous result. | |
| orderBy | No | Sorting order for replies. Available Values: - `score`: Sort by highest score. - `ts`: Sort by latest time. | |
| commentId | Yes | Comment ID |
justoneapi_get_api_zhihu_get_user_articles_v1Zhihu User Articles API (V1)Inspect
Retrieve articles published by a Zhihu user with offset pagination and publish-time or upvote sorting. Use it to browse a creator's articles in the selected order. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| sortType | No | Sorting criteria for user articles. Available Values: - `created`: Sort by publish time. - `voteups`: Sort by upvote count. | |
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_get_user_follow_collections_v1Zhihu User Follow Collections API (V1)Inspect
Retrieve Zhihu collections followed by a user, with offset pagination. Use it to browse the collections associated with a known account's follow activity. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_get_user_follow_columns_v1Zhihu User Follow Columns API (V1)Inspect
Retrieve Zhihu columns followed by a user, with offset pagination. Use it to browse the columns associated with a known account's follow activity. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_get_user_followees_v1Zhihu User Followees API (V1)Inspect
Retrieve accounts followed by a Zhihu user, with offset pagination. Use it to explore the outgoing connections of a known account. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_get_user_followers_v1Zhihu User Followers API (V1)Inspect
Retrieve accounts that follow a Zhihu user, with offset pagination. Use it to explore the audience connections of a known account. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_get_user_follow_topics_v1Zhihu User Follow Topics API (V1)Inspect
Retrieve Zhihu topics followed by a user, with offset pagination. Use it to browse the topics associated with a known account's follow activity. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_get_user_included_articles_v1Zhihu User Included Articles API (V1)Inspect
Retrieve the included-article records exposed for a Zhihu user, with offset pagination. Use it to browse that account's included-article list. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start offset, begins with 0. | |
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_get_user_info_v1Zhihu User Info API (V1)Inspect
Retrieve the public profile for a Zhihu user identified by URL token. Use it to inspect an account found through Zhihu content or relationship data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userUrlToken | Yes | Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`. |
justoneapi_get_api_zhihu_search_v1Zhihu Keyword Search API (V1)Inspect
Search Zhihu by keyword with optional result-type, sort, time-interval, topic-display, and offset controls. Use it to find relevant answers, articles, or videos. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sorting criteria. Available Values: - `upvoted_count`: Most upvoted. - `created_time`: Latest published. | |
| offset | No | Start offset, begins with 0. | |
| keyword | Yes | Search keywords. | |
| vertical | No | Result type filter. Available Values: - `answer`: Answers only. - `article`: Articles only. - `zvideo`: Videos only. | |
| timeInterval | No | Publish time interval filter. Available Values: - `a_day`: Within one day. - `a_week`: Within one week. - `a_month`: Within one month. - `three_months`: Within three months. - `half_a_year`: Within half a year. - `a_year`: Within one year. | |
| showAllTopics | No | Whether to show all topics. Available Values: - `FALSE`: Do not show topics. - `TRUE`: Show all topics. |
justoneapi_post_api_1688_convert_image_v11688 Image Conversion API (V1)Inspect
Converts an image URL or JPEG Base64 input into an image reference for a selected 1688 image search endpoint. Use it to prepare external images for visual product sourcing. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Image input and the intended 1688 image search target. |
justoneapi_post_api_weixin_channels_search_account_v2WeChat Channels Account Search API (V2)Inspect
Searches WeChat Channels account-related records by keyword using the direct Channels lookup. Use it to discover creator accounts and related channel objects without pagination input. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Search keyword used to find WeChat Channels accounts and related video objects. |
justoneapi_post_api_weixin_channels_search_account_v3WeChat Channels Account Search API (V3)Inspect
Looks up a specific WeChat Channels account identity by keyword. Use it to resolve a creator name or account term to the identifier required by account-video queries. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Search keyword used to resolve a WeChat Channels account id. |
justoneapi_post_api_weixin_search_account_v1WeChat Official Accounts Account Search API (V1)Inspect
Searches WeChat Official Accounts by keyword with page-number pagination and one result per page. Use it to find an account by name or related term before profile or article lookup. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number starting from 1 for WeChat Official Account profile search. | |
| keyword | Yes | Search keyword for WeChat Official Account profiles. |
keenable_get_v1_fetch_publicKeenable Public FetchInspect
Keenable Public Fetch Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL of the page to fetch | |
| live | No | Fetch the page live from the source instead of returning Keenable's indexed copy. Enables fetching URLs that are not indexed. | |
| prompt | No | Optional extraction instruction. When set, an LLM reads the fetched page and the response content is only the output for this instruction instead of the full page. Example: "List all pricing tiers with their monthly prices". | |
| max_chars | No | Maximum number of characters of content to return. Longer content is truncated and a notice is appended after the cut, so the response runs slightly past this number. | |
| X-Keenable-Title | Yes | Required application identifier. Values longer than 256 characters are truncated. Alternatively supply the keenable_title query parameter. |
keenable_post_v1_search_publicKeenable Public SearchInspect
Keenable Public Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | "pro" (default) for deeper retrieval, "realtime" for fast results | |
| site | No | Restrict results to a specific domain | |
| query | Yes | Search query | |
| query_time | No | Search the index as it stood at this point in time: pages acquired after it are excluded. A bare YYYY-MM-DD resolves to 00:00:00 UTC. Relative deltas on the date filters are computed from this instant instead of the request time | |
| max_results | No | Maximum number of results to return. When omitted, up to 10 results are returned. | |
| acquired_after | No | Filter: pages acquired after this date (YYYY-MM-DD, ISO 8601, or relative like "7d") | |
| acquired_before | No | Filter: pages acquired before this date. A bare YYYY-MM-DD includes that whole day (up to 23:59:59.999 UTC); pass a timestamp to cut at an exact instant | |
| published_after | No | Filter: pages published after this date | |
| X-Keenable-Title | Yes | Required application identifier. Values longer than 256 characters are truncated. Alternatively supply the keenable_title query parameter. | |
| published_before | No | Filter: pages published before this date. A bare YYYY-MM-DD includes that whole day (up to 23:59:59.999 UTC); pass a timestamp to cut at an exact instant | |
| snippet_max_length | No | Maximum length, in characters, of the snippet returned per result. When omitted, a default snippet length is used. |
lifi_get_v1_analytics_transfersLI.FI — Get a list of filtered transfersInspect
This endpoint can be used to retrieve a list of transfers filtered by certain properties. Returns a maximum of 1000 transfers. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | The status of the transfers. Possible values are `ALL`, `DONE`, `PENDING`, and `FAILED`. The default is `DONE` | |
| wallet | No | The sending OR receiving wallet address | |
| toChain | No | The chain where the transfer ends. | |
| toToken | No | The token received on the destination chain. To use this parameter `toChain` must be set. | |
| fromChain | No | The chain where the transfer originates from. | |
| fromToken | No | The token transferred from the originating chain. To use this parameter `fromChain` must be set. | |
| integrator | No | The integrator string to filter by | |
| toTimestamp | No | The newest timestamp that should be taken into consideration. Defaults to now | |
| fromTimestamp | No | The oldest timestamp that should be taken into consideration. Defaults to 30 days ago |
lifi_get_v1_analytics_transfers_summaryLI.FI — Get the total amount of a token received on a specific chain, for cross-chain transfers.Inspect
Calculates and returns the total received token amount per wallet address, per sending chain, within a specified time range, for a given receiving chain and receiving token. Only aggregates cross-chain transfers, meaning transfers with distinct sending and receiving chains. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | The next page cursor. Must come from the `next` field of the response of the previous request. | |
| limit | No | Pagination limit. Defines the maximum number of returned results. | |
| toChain | Yes | The ID, or key of the chain on the receiving side of the transfer. This parameter filters the summary to include only transfers received on the specified chain. | |
| toToken | Yes | The address, or symbol of the token received in the transfers. This parameter filters the summary to include only transfers involving the specified token on the receiving chain. | |
| previous | No | The previous page cursor. Must come from the `previous` field of the response of the previous request. | |
| fromChain | No | The ID, or key of the chain on the sending side of the transfers. This parameter filters the summary to include only transfers sent from the specified chain. | |
| integrator | No | The integrator string to filter transfers by. This parameter filters the summary to include only transfers for the given integrator. | |
| toTimestamp | Yes | A Unix timestamp in seconds marking the end of the query period, inclusive. Transactions after this timestamp will not be included in the summary. **The maximum range supported by the endpoint is 30 days.** | |
| fromTimestamp | Yes | A Unix timestamp in seconds marking the start of the query period, inclusive. Transactions older than this timestamp will not be included in the summary. |
lifi_get_v1_calldata_parseLI.FI — Parse transaction call data (BETA)Inspect
LI.FI — Parse transaction call data (BETA) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | No | The chainId that the transaction is built for (or has been sent on) | |
| callData | Yes | The call data to parse |
lifi_get_v1_chainsLI.FI — Get information about all currently supported chainsInspect
If you want to learn more about how to use this endpoint please have a look at our guide. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainTypes | No | Restrict the resulting chains to the given chainTypes. Available values: EVM, SVM, UTXO, MVM, TVM, STL. Pass all values to get every supported chain. If this parameter is omitted, the API returns only EVM chains. |
lifi_get_v1_connectionsLI.FI — Returns all possible connections between two chains.Inspect
This endpoint gives information about all possible transfers between chains. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| toChain | Yes | The chain that should be the end of the possible connections. | |
| toToken | No | Only return connections ending with this token. | |
| fromChain | Yes | The chain that should be the start of the possible connections. | |
| fromToken | No | Only return connections starting with this token. | |
| chainTypes | No | Restrict the resulting connections to the given chainTypes. Available values: EVM, SVM, UTXO, MVM, TVM, STL. | |
| denyBridges | No | List of bridges that are not allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. | |
| allowBridges | No | List of bridges that are allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. | |
| denyExchanges | No | List of exchanges that are not allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. | |
| preferBridges | No | List of bridges that should be preferred for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. | |
| allowExchanges | No | List of exchanges that are allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. | |
| preferExchanges | No | List of exchanges that should be preferred for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. | |
| allowSwitchChain | No | Whether connections that require chain switch should be included in the response. | |
| allowDestinationCall | No | Whether connections that includes destination call should be included in the response. |
lifi_get_v1_gas_pricesLI.FI — Get gas prices for enabled chainsInspect
This endpoint can be used to get the most recent gas prices for the enabled chains in the server. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
lifi_get_v1_gas_prices_chainidLI.FI — Get gas price for the specified chainIdInspect
This endpoint can be used to get the most recent gas prices for the supplied chainId. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | Yes | ChaindId from which gas prices should be shown |
lifi_get_v1_gas_suggestion_chainLI.FI — Get a gas suggestion for the specified chainInspect
Endpoint to retrieve a suggestion on how much gas is needed on the requested chain. The suggestion is based on the average price of 10 approvals and 10 uniswap based swaps via LI.FI on the specified chain. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain | Yes | Chain from which gas prices should be shown (can be a chain id or a chain key) | |
| fromChain | No | If `fromChain` and `fromToken` are specified, the result will contain information about how much `fromToken` amount the user has to send to receive the suggested gas amount on the requested chain. | |
| fromToken | No | If `fromChain` and `fromToken` are specified, the result will contain information about how much `fromToken` amount the user has to send to receive the suggested gas amount on the requested chain. |
lifi_get_v1_quoteLI.FI — Get a quote for a token transferInspect
This endpoint can be used to request a quote for a transfer of one token to another, cross chain or not. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| fee | No | The percent of the integrator's fee that is taken from every transaction. 0.02 represents 2%. The maximum fee amount should be less than 100%. | |
| order | No | Which kind of route should be preferred **FASTEST**: This sorting criterion prioritizes routes with the shortest estimated execution time. Users who value speed and want their transactions to be completed as quickly as possible should choose the fastest routes. **CHEAPEST**: This criterion focuses on minimizing the cost of the transaction, whether in token amount or USD amount (USD amount minus gas cost). Users looking for the most economical option should choose the cheapest routes. | |
| preset | No | Pre-configured routing optimization preset. The preset value `stablecoin` is supported for requesting swap and/or bridging operations involving stablecoin tokens. Each preset provides optimized default settings for slippage, price impact, and tool preferences that can be overridden by custom configuration parameters set in the request. | |
| toChain | Yes | The receiving chain. Can be the chain id or chain key | |
| toToken | Yes | The token that should be transferred to. Can be the address or the symbol | |
| referrer | No | A string containing tracking information about the referrer of the integrator | |
| slippage | No | The maximum allowed slippage for the transaction as a decimal value. 0.005 represents 0.5%. | |
| denyPools | No | One to 100 AMM pool or Solana venue identifiers to exclude from routing. Repeat the query parameter for multiple entries. Each entry is a non-zero Uniswap V2/V3 pool address (`0x` + 40 hex), a Uniswap V4 composite `-` where `poolId` is a 32-byte hex string (`0x` + 64 hex), or a Solana venue program ID (base58), which excludes every pool of that venue. Identifiers of other chains are rejected; individual Solana pool addresses are not supported. Only some exchanges can exclude pools: EVM pool entries restrict swaps on every chain except Solana to the `fly` exchange, and Solana program IDs restrict swaps on Solana to `jupiter`, `titan` and `okx`. Swaps on a chain with no matching entries are not restricted. | |
| fromChain | Yes | The sending chain. Can be the chain id or chain key | |
| fromToken | Yes | The token that should be transferred. Can be the address or the symbol | |
| toAddress | No | The receiving wallet address. If none is provided, the fromAddress will be used | |
| fromAmount | Yes | The amount that should be sent including all decimals (e.g. 1000000 for 1 USDC (6 decimals)) | |
| integrator | No | A string containing tracking information about the integrator of the API | |
| denyBridges | No | List of bridges that are not allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| fromAddress | Yes | The sending wallet address | |
| allowBridges | No | List of bridges that are allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| denyExchanges | No | List of exchanges that are not allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| preferBridges | No | List of bridges that should be preferred for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| allowExchanges | No | List of exchanges that are allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| maxPriceImpact | No | The price impact threshold above which routes are hidden. As an example, one should specify 0.15 (15%) to hide routes with more than 15% price impact. The default is 10%. | |
| skipSimulation | No | Parameter to skip transaction simulation. The quote will be returned faster but the transaction gas limit won't be accurate. | |
| preferExchanges | No | List of exchanges that should be preferred for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| fromAmountForGas | No | The amount of the token to convert to gas on the destination side. | |
| svmPriorityFeeLevel | No | Priority fee level for Solana Virtual Machine (SVM) transactions. | |
| allowDestinationCall | No | Whether swaps or other contract calls should be allowed as part of the destination transaction of a bridge transfer. Separate swap transactions on the destination chain are not affected by this flag. By default, parameter is `true`. | |
| routeTimingStrategies | No | Timing setting to wait for a certain amount of routes to be generated before chosing the best one. In the format `minWaitTime-${minWaitTimeMs}-${startingExpectedResults}-${reduceEveryMs}`. Please check [docs.li.fi](https://docs.li.fi) for more details. | |
| swapStepTimingStrategies | No | Timing setting to wait for a certain amount of swap rates. In the format `minWaitTime-${minWaitTimeMs}-${startingExpectedResults}-${reduceEveryMs}`. Please check [docs.li.fi](https://docs.li.fi) for more details. | |
| svmMaxSupportedTransactionVersion | No | Maximum Solana transaction version the client can sign. Defaults to 0; omission or null uses v0. Set to 1 to allow V1 where enabled for the environment. Jito requests always use v0. Size overflow may fall back to v0. Read transactionRequest.svmTransactionVersion for the version actually built. Ignored for source chains other than Solana. |
lifi_get_v1_quote_toamountLI.FI — Get a quote for a token transferInspect
This endpoint is an alternative to the v1/quote endpoint, taking a toAmount value rather than fromAmount. This endpoint will calculate an appropriate fromAmount based on the specified toAmount, and use this value to generate the quote data.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| fee | No | The percent of the integrator's fee that is taken from every transaction. 0.02 represents 2%. The maximum fee amount should be less than 100%. | |
| order | No | Which kind of route should be preferred **FASTEST**: This sorting criterion prioritizes routes with the shortest estimated execution time. Users who value speed and want their transactions to be completed as quickly as possible should choose the fastest routes. **CHEAPEST**: This criterion focuses on minimizing the cost of the transaction, whether in token amount or USD amount (USD amount minus gas cost). Users looking for the most economical option should choose the cheapest routes. | |
| toChain | Yes | The receiving chain. Can be the chain id or chain key | |
| toToken | Yes | The token that should be transferred to. Can be the address or the symbol | |
| referrer | No | A string containing tracking information about the referrer of the integrator | |
| slippage | No | The maximum allowed slippage for the transaction as a decimal value. 0.005 represents 0.5%. | |
| toAmount | Yes | The amount that will be received including all decimals (e.g. 1000000 for 1 USDC (6 decimals)) | |
| fromChain | Yes | The sending chain. Can be the chain id or chain key | |
| fromToken | Yes | The token that should be transferred. Can be the address or the symbol | |
| toAddress | No | The receiving wallet address. If none is provided, the fromAddress will be used | |
| integrator | No | A string containing tracking information about the integrator of the API | |
| denyBridges | No | List of bridges that are not allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| fromAddress | Yes | The sending wallet address | |
| allowBridges | No | List of bridges that are allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| denyExchanges | No | List of exchanges that are not allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| preferBridges | No | List of bridges that should be preferred for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| allowExchanges | No | List of exchanges that are allowed for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| maxPriceImpact | No | The price impact threshold above which routes are hidden. As an example, one should specify 0.15 (15%) to hide routes with more than 15% price impact. The default is 10%. | |
| preferExchanges | No | List of exchanges that should be preferred for this transaction. Retrieve the current catalog from the `/v1/tools` endpoint. Also values `all`, `none`, `default` and `[]` are acceptable and mean all tools of the current type (`all`), no tools (for `none` and `[]` cases) and default tool's settings on the current stage. | |
| svmPriorityFeeLevel | No | Priority fee level for Solana Virtual Machine (SVM) transactions. | |
| allowDestinationCall | No | Whether swaps or other contract calls should be allowed as part of the destination transaction of a bridge transfer. Separate swap transactions on the destination chain are not affected by this flag. By default, parameter is `true`. | |
| routeTimingStrategies | No | Timing setting to wait for a certain amount of routes to be generated before chosing the best one. In the format `minWaitTime-${minWaitTimeMs}-${startingExpectedResults}-${reduceEveryMs}`. Please check [docs.li.fi](https://docs.li.fi) for more details. | |
| swapStepTimingStrategies | No | Timing setting to wait for a certain amount of swap rates. In the format `minWaitTime-${minWaitTimeMs}-${startingExpectedResults}-${reduceEveryMs}`. Please check [docs.li.fi](https://docs.li.fi) for more details. | |
| svmMaxSupportedTransactionVersion | No | Maximum Solana transaction version the client can sign. Defaults to 0; omission or null uses v0. Set to 1 to allow V1 where enabled for the environment. Jito requests always use v0. Size overflow may fall back to v0. Read transactionRequest.svmTransactionVersion for the version actually built. Ignored for source chains other than Solana. |
lifi_get_v1_statusLI.FI — Check the status of a cross chain transferInspect
Cross chain transfers might take a while to complete. Waiting on the transaction on the sending chain doesn't help here. For this reason we build a simple endpoint that let's you check the status of your transfer. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bridge | No | The bridging tool used for the transfer | |
| txHash | Yes | The transaction hash on the sending chain, destination chain or lifi step id | |
| toChain | No | The receiving chain. Can be the chain id or chain key | |
| fromChain | No | The sending chain. Can be the chain id or chain key |
lifi_get_v1_tokenLI.FI — Fetch information about a TokenInspect
This endpoint can be used to get more information about a token by its address or symbol and its chain. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chain | Yes | Id or key of the chain that contains the token | |
| token | Yes | Address or symbol of the token on the requested chain |
lifi_get_v1_tokensLI.FI — Fetch all known tokensInspect
This endpoint can be used to fetch all tokens known to the LI.FI services. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Restrict the resulting tokens to the given token tags (comma separated) | |
| chains | No | Restrict the resulting tokens to the given chains | |
| chainTypes | No | Restrict the resulting tokens to the given chainTypes. Available values: EVM, SVM, UTXO, MVM, TVM, STL. | |
| minPriceUSD | No | Filters results by minimum token price in USD. Minimum value for this parameter is 0. Defaults to 0.0001 USD. |
lifi_get_v1_toolsLI.FI — Get available bridges and exchangesInspect
This endpoint can be used to get information about the bridges and exchanges available trough our service Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
lifi_get_v2_analytics_transfersLI.FI — Get a paginated list of filtered transfersInspect
A paginated version of the GET /v1/analytics/transfers endpoint. This endpoint can be used to retrieve a list of transfers filtered by certain properties. Documentation prepared only; runtime not verified.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | The next page cursor. Must come from the `next` field of the response of the previous request. | |
| limit | No | Pagination limit. Defines the maximum number of returned results. | |
| status | No | The status of the transfers. Possible values are `ALL`, `DONE`, `PENDING`, and `FAILED`. The default is `DONE` | |
| wallet | No | The sending OR receiving wallet address | |
| toChain | No | The chain where the transfer ends. | |
| toToken | No | The token received on the destination chain. To use this parameter `toChain` must be set. | |
| previous | No | The previous page cursor. Must come from the `previous` field of the response of the previous request. | |
| fromChain | No | The chain where the transfer originates from. | |
| fromToken | No | The token transferred from the originating chain. To use this parameter `fromChain` must be set. | |
| integrator | No | Either a single integrator string, or an array of unique integrator strings to filter transfers by. Import profile accepts the string branch only; other union branches are not exposed. | |
| toTimestamp | No | The newest timestamp that should be taken into consideration. Defaults to now | |
| fromTimestamp | No | The oldest timestamp that should be taken into consideration. Defaults to 30 days ago |
lifi_post_v1_advanced_routesLI.FI — Get a set of routes for a request that describes a transfer of tokensInspect
In order to execute any transfer, you must first request possible Routes. From the result set a Route can be selected and executed by retrieving the transaction for every included Step using the /steps/transaction endpoint.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | A description of a token transfer |
lifi_post_v1_advanced_steptransactionLI.FI — Populate a step with transaction dataInspect
This endpoint expects a full Step object which usually is retrieved by calling the /advanced/routes endpoint and selecting the most suitable Route. Afterwards the transaction for every required Step can be retrieved using this endpoint.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Object that represents one step of a `Route` | |
| denyPools | No | One to 100 AMM pool or Solana venue identifiers to exclude when building transaction data. If the route was requested with `options.pools.deny`, you must pass the same list again for each step: pool exclusions are request-scoped and are not carried in the returned Step. Without it, swaps are re-quoted with no exclusions, so the transaction can use an excluded pool or venue. Repeat the query parameter for multiple entries, as with `/v1/quote`. Each entry is a non-zero Uniswap V2/V3 EVM pool address (`0x` + 40 hex), a Uniswap V4 `-` identifier, where `poolId` is `0x` + 64 hex, or a Solana venue program ID (base58). EVM pool exclusion is supported only by `fly`; Solana venue exclusion only by `jupiter`, `titan` and `okx`. If the list holds a Solana program ID, a step that swaps on Solana through any other exchange is rejected with a 400 error instead of being built without the exclusion. Keep the Step object in the JSON request body. | |
| skipSimulation | No | Parameter to skip transaction simulation. The quote will be returned faster but the transaction gas limit won't be accurate. | |
| svmPriorityFeeLevel | No | Priority fee level for Solana Virtual Machine (SVM) transactions. | |
| mayanNonEvmPermitSignature | No | Mayan specific option to bridge from non-EVM chain to Hyperliquid | |
| svmMaxSupportedTransactionVersion | No | Maximum Solana transaction version the client can sign. Defaults to 0; omission or null uses v0. Set to 1 to allow V1 where enabled for the environment. Jito requests always use v0. Size overflow may fall back to v0. Read transactionRequest.svmTransactionVersion for the version actually built. Ignored for source chains other than Solana. |
lifi_post_v1_quote_contractcallsLI.FI — Perform multiple contract calls across blockchains (BETA)Inspect
This endpoint can be used to bridge tokens, swap them and perform a number or arbitrary contract calls on the destination chain. You can find an example of it here. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Object defining instructions on how to perform multiple cross-chain/same-chain calls |
litescrape_post_api_airbnb_searchAirbnb SearchInspect
Search Airbnb stays by destination and dates. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Airbnb stays by destination and dates. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_aliexpress_productAliExpress ProductInspect
Get an AliExpress product's details and price. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an AliExpress product's details and price. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_aliexpress_searchAliExpress SearchInspect
Search AliExpress products with prices. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search AliExpress products with prices. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_amazon_autocompleteAmazon AutocompleteInspect
Get Amazon search suggestions for a prefix and department. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Amazon search suggestions for a prefix and department. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_amazon_featured_reviewsAmazon Featured ReviewsInspect
Get the featured reviews for an Amazon product. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get the featured reviews for an Amazon product. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_amazon_media_reviewsAmazon Media ReviewsInspect
Get Amazon reviews that include photos or videos. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Amazon reviews that include photos or videos. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_amazon_productAmazon ProductInspect
Get an Amazon product page, with optional seller offers. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an Amazon product page, with optional seller offers. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_amazon_searchAmazon SearchInspect
Search Amazon products. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Amazon products. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_apartments_propertyApartments.com PropertyInspect
Get an Apartments.com property by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an Apartments.com property by URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_apartments_searchApartments.com SearchInspect
Search Apartments.com listings from a search URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Apartments.com listings from a search URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_apple_app_store_productApple App Store ProductInspect
Get an App Store app's details, ratings and version history. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an App Store app's details, ratings and version history. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_apple_app_store_reviewsApple App Store ReviewsInspect
Get reviews for an App Store app. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get reviews for an App Store app. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_apple_app_store_searchApple App Store SearchInspect
Search the App Store for iPhone, iPad and Mac apps. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search the App Store for iPhone, iPad and Mac apps. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_apple_maps_placesApple Maps PlacesInspect
Search Apple Maps places. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Apple Maps places. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_apple_maps_reviewsApple Maps ReviewsInspect
Get Apple ratings and reviews for an Apple Maps place. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Apple ratings and reviews for an Apple Maps place. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_ashby_searchJobs by Ashby SearchInspect
Search jobs on a company's Ashby job board. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search jobs on a company's Ashby job board. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_baidu_searchBaidu SearchInspect
Get Baidu search results as JSON. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Baidu search results as JSON. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_bestbuy_productBest Buy ProductInspect
Get a Best Buy product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Best Buy product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_bestbuy_searchBest Buy SearchInspect
Search Best Buy products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Best Buy products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_bing_imagesBing ImagesInspect
Search Bing Images with size, color, date and license filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Bing Images with size, color, date and license filters. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_bing_mapsBing MapsInspect
Search Bing Maps places, or get one place by ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Bing Maps places, or get one place by ID. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_bing_productBing ProductInspect
Get a Bing Shopping product's details using its product token. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Bing Shopping product's details using its product token. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_bing_searchBing SearchInspect
Get Bing web search results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Bing web search results. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_bing_shoppingBing ShoppingInspect
Search Bing Shopping products. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Bing Shopping products. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_brave_ai_modeBrave AI ModeInspect
Get Brave AI answers with citations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Brave AI answers with citations. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_brave_searchBrave SearchInspect
Get Brave web search results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Brave web search results. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_duckduckgo_mapsDuckDuckGo MapsInspect
Search DuckDuckGo Maps places within a map area. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search DuckDuckGo Maps places within a map area. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_duckduckgo_searchDuckDuckGo SearchInspect
Get DuckDuckGo web search results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get DuckDuckGo web search results. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_ebay_producteBay ProductInspect
Get an eBay listing by item ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an eBay listing by item ID. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_ebay_searcheBay SearchInspect
Search eBay listings by keyword or category. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search eBay listings by keyword or category. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_ebay_sellereBay SellerInspect
Get an eBay seller's profile and listings. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an eBay seller's profile and listings. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_etsy_productEtsy ProductInspect
Get an Etsy listing's details and price. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an Etsy listing's details and price. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_etsy_searchEtsy SearchInspect
Search Etsy listings with prices. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Etsy listings with prices. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_eventbrite_searchEventbrite SearchInspect
Search Eventbrite events by location and keyword. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Eventbrite events by location and keyword. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_facebook_hashtag_postsFacebook Hashtag PostsInspect
Get public Facebook posts for a hashtag. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get public Facebook posts for a hashtag. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_facebook_marketplace_browseFacebook Marketplace BrowseInspect
Browse or search Facebook Marketplace listings by city. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Browse or search Facebook Marketplace listings by city. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_facebook_page_postsFacebook Page PostsInspect
Get recent public posts from a Facebook Page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get recent public posts from a Facebook Page. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_facebook_postFacebook Post DetailsInspect
Get a public Facebook post by its URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a public Facebook post by its URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_facebook_reelFacebook Reel DetailsInspect
Get a public Facebook reel by its URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a public Facebook reel by its URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_facebook_search_pagesFacebook Search PagesInspect
Search public Facebook Pages by name. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search public Facebook Pages by name. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_facebook_search_profilesFacebook Search ProfilesInspect
Search public Facebook profiles by name. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search public Facebook profiles by name. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_glassdoor_searchGlassdoor SearchInspect
Search Glassdoor jobs by keyword and location, with salary, seniority and remote filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Glassdoor jobs by keyword and location, with salary, seniority and remote filters. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_adsGoogle AdsInspect
Get the ads shown on a Google search results page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get the ads shown on a Google search results page. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_ai_modeGoogle AI ModeInspect
Get Google AI Mode answers with cited sources. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Google AI Mode answers with cited sources. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_ai_overviewGoogle AI OverviewInspect
Get Google's AI Overview for a query, with cited sources. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Google's AI Overview for a query, with cited sources. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_contributor_reviewsGoogle Contributor ReviewsInspect
Get reviews written by a Google Maps contributor. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get reviews written by a Google Maps contributor. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_geminiGemini ChatInspect
Get a completed text reply from Gemini. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_imagesGoogle ImagesInspect
Search Google Images. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Google Images. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_jobsGoogle JobsInspect
Search Google Jobs listings by query and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Google Jobs listings by query and location. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_localGoogle LocalInspect
Get Google local results for a query and location. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Google local results for a query and location. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_mapsGoogle MapsInspect
Search Google Maps places, or get one place by ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Google Maps places, or get one place by ID. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_maps_photo_metaGoogle Maps Photo MetadataInspect
Get the place, contributor, and date of a Maps photo. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get the place, contributor, and date of a Maps photo. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_maps_popular_timesGoogle Maps Popular TimesInspect
See how busy a place is right now. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | See how busy a place is right now. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_maps_postsGoogle Maps PostsInspect
Read the posts published by a business. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Read the posts published by a business. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_play_appsGoogle Play AppsInspect
Search and browse Google Play apps. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search and browse Google Play apps. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_play_booksGoogle Play BooksInspect
Search and browse Google Play ebooks and audiobooks. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search and browse Google Play ebooks and audiobooks. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_play_gamesGoogle Play GamesInspect
Browse Google Play games by category and chart. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Browse Google Play games by category and chart. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_play_moviesGoogle Play MoviesInspect
Search and browse Google Play movies and TV shows. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search and browse Google Play movies and TV shows. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_play_productGoogle Play ProductInspect
Get a Google Play app, book, movie or show by ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Google Play app, book, movie or show by ID. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_play_reviewsGoogle Play ReviewsInspect
Get reviews for a Google Play app. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get reviews for a Google Play app. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_reviewsGoogle Maps ReviewsInspect
Get reviews for a Google Maps place. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get reviews for a Google Maps place. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_searchGoogle SearchInspect
Get Google search results, including the AI Overview and People also ask. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Google search results, including the AI Overview and People also ask. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_shoppingGoogle ShoppingInspect
Search Google Shopping products. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Google Shopping products. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_shopping_merchant_urlsGoogle Shopping Merchant URLsInspect
Get direct merchant URLs for Google Shopping offers. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get direct merchant URLs for Google Shopping offers. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_google_shopping_productGoogle Shopping ProductInspect
Get every merchant offer for a Google Shopping product. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get every merchant offer for a Google Shopping product. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_homedepot_productHome Depot ProductInspect
Get a Home Depot product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Home Depot product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_homedepot_searchHome Depot SearchInspect
Search Home Depot products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Home Depot products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_homes_propertyHomes.com PropertyInspect
Get a Homes.com property by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Homes.com property by URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_homes_searchHomes.com SearchInspect
Search Homes.com listings from a search URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Homes.com listings from a search URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_ikea_productIKEA ProductInspect
Get an IKEA product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an IKEA product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_ikea_searchIKEA SearchInspect
Search IKEA products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search IKEA products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_indeed_searchIndeed SearchInspect
Search Indeed jobs by keyword and location, with salary, experience and remote filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Indeed jobs by keyword and location, with salary, experience and remote filters. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_instagram_embedInstagram EmbedInspect
Retrieve public Instagram embed data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve public Instagram embed data. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_instagram_postInstagram PostInspect
Retrieve public Instagram post data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve public Instagram post data. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_instagram_postsInstagram PostsInspect
Retrieve public Instagram posts data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve public Instagram posts data. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_instagram_profileInstagram ProfileInspect
Retrieve public Instagram profile data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve public Instagram profile data. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_instagram_profile_post_countInstagram Profile Post CountInspect
Retrieve public Instagram profile post count data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve public Instagram profile post count data. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_instagram_search_popularInstagram Search PopularInspect
Get popular Instagram posts for a search topic. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get popular Instagram posts for a search topic. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_kroger_productKroger ProductInspect
Get a Kroger product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Kroger product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_kroger_searchKroger SearchInspect
Search Kroger products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Kroger products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_levels_searchLevels.fyi SearchInspect
Search Levels.fyi jobs by company, location, level and pay. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Levels.fyi jobs by company, location, level and pay. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_realtor_propertyRealtor.com PropertyInspect
Get a Realtor.com property by URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Realtor.com property by URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_realtor_searchRealtor.com SearchInspect
Search Realtor.com listings from a search URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Realtor.com listings from a search URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_redfin_propertyRedfin PropertyInspect
Get a Redfin property by listing URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Redfin property by listing URL. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_redfin_searchRedfin SearchInspect
Search Redfin homes for sale or recently sold. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Redfin homes for sale or recently sold. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_sprouts_productSprouts ProductInspect
Get a Sprouts product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Sprouts product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_sprouts_searchSprouts SearchInspect
Search Sprouts products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Sprouts products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_target_productTarget ProductInspect
Get a product sold by the US retailer Target, with its details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a product sold by the US retailer Target, with its details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_target_searchTarget SearchInspect
Search products sold by the US retailer Target, with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search products sold by the US retailer Target, with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_collection_videosTikTok Collection VideosInspect
Page through posts saved in a public TikTok collection. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Page through posts saved in a public TikTok collection. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_comment_repliesTikTok Comment RepliesInspect
Page through replies to a TikTok comment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Page through replies to a TikTok comment. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_commentsTikTok CommentsInspect
Page through public comments on a TikTok post. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Page through public comments on a TikTok post. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_followersTikTok FollowersInspect
Page through public followers of a TikTok user. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Page through public followers of a TikTok user. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_followingTikTok FollowingInspect
Page through the public accounts a TikTok user follows. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Page through the public accounts a TikTok user follows. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_liveTikTok Live RoomInspect
Get a TikTok live room's status and metrics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a TikTok live room's status and metrics. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_profileTikTok ProfileInspect
Get public TikTok profile fields and statistics by handle or numeric user ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get public TikTok profile fields and statistics by handle or numeric user ID. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_profile_videosTikTok Profile VideosInspect
Page through posts from a public TikTok profile by handle or numeric user ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Page through posts from a public TikTok profile by handle or numeric user ID. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_search_hashtagTikTok Search HashtagInspect
Resolve a public hashtag and page through its posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Resolve a public hashtag and page through its posts. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_search_keywordTikTok Search KeywordInspect
Search public TikTok posts by keyword with pagination and search-session IDs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search public TikTok posts by keyword with pagination and search-session IDs. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_search_suggestionsTikTok Search SuggestionsInspect
Get public TikTok autocomplete suggestions in order. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get public TikTok autocomplete suggestions in order. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_search_topTikTok Search TopInspect
Get TikTok's top search results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get TikTok's top search results. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_songTikTok SongInspect
Get a TikTok sound's details and usage count. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a TikTok sound's details and usage count. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_song_videosTikTok Song VideosInspect
Page through TikTok posts that use a sound. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Page through TikTok posts that use a sound. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_transcriptTikTok TranscriptInspect
Get public TikTok captions with timed segments. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get public TikTok captions with timed segments. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_trending_feedTikTok Trending FeedInspect
Get TikTok's trending feed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get TikTok's trending feed. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_user_liveTikTok User LiveInspect
Get a TikTok user's live status and room metadata. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a TikTok user's live status and room metadata. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tiktok_videoTikTok VideoInspect
Get a TikTok video or photo post with its media and metrics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a TikTok video or photo post with its media and metrics. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tripadvisor_placeTripadvisor PlaceInspect
Get a Tripadvisor place by ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Tripadvisor place by ID. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tripadvisor_reviewsTripadvisor ReviewsInspect
Get reviews for a Tripadvisor place. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get reviews for a Tripadvisor place. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_tripadvisor_searchTripadvisor SearchInspect
Search Tripadvisor hotels, restaurants and attractions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Tripadvisor hotels, restaurants and attractions. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_walmart_productWalmart ProductInspect
Get a Walmart product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Walmart product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_walmart_searchWalmart SearchInspect
Search Walmart products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Walmart products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_wayfair_productWayfair ProductInspect
Get a Wayfair product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Wayfair product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_wayfair_searchWayfair SearchInspect
Search Wayfair products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Wayfair products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_web_fetchFetchInspect
Get a web page as Markdown, HTML or plain text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a web page as Markdown, HTML or plain text. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_web_screenshotScreenshotInspect
Take a screenshot of a web page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Take a screenshot of a web page. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_wholefoods_productWhole Foods ProductInspect
Get a Whole Foods product's details, price and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a Whole Foods product's details, price and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_wholefoods_searchWhole Foods SearchInspect
Search Whole Foods products with prices and availability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Whole Foods products with prices and availability. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_x_communityX CommunityInspect
Get X community details, including its creator, member count and rules. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get X community details, including its creator, member count and rules. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_x_community_postsX Community PostsInspect
Get posts from an X community, including authors, engagement and media. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get posts from an X community, including authors, engagement and media. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_x_postX PostInspect
Get an X post with its text, author, engagement counts and media. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get an X post with its text, author, engagement counts and media. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_x_profileX ProfileInspect
Get a public X profile, including its bio, follower counts and profile images. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a public X profile, including its bio, follower counts and profile images. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_x_user_postsX User PostsInspect
Get posts from an X user. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get posts from an X user. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_yahoo_imagesYahoo ImagesInspect
Search Yahoo Images. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Yahoo Images. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_yahoo_searchYahoo SearchInspect
Get Yahoo web search results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Yahoo web search results. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_yandex_imagesYandex ImagesInspect
Search Yandex Images, including reverse image search. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Yandex Images, including reverse image search. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_yandex_searchYandex SearchInspect
Get Yandex web search results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Yandex web search results. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_yelp_reviewsYelp ReviewsInspect
Get reviews for a Yelp business. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get reviews for a Yelp business. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_yelp_searchYelp SearchInspect
Search Yelp businesses by location and category. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search Yelp businesses by location and category. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
litescrape_post_api_youtube_channelYouTube ChannelInspect
Get a YouTube channel's profile, videos, Shorts, playlists and posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a YouTube channel's profile, videos, Shorts, playlists and posts. | |
| timeout | No | Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget. |
nws_get_alerts_activeNWS US Active Weather AlertsInspect
List active National Weather Service weather alerts for a US state or territory. An empty features array means no active alerts matched the filter. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| area | Yes | Two-letter US state or territory code, such as CA. |
nws_get_hourly_office_gridNWS US Hourly Weather ForecastInspect
Get hourly weather forecast periods for a National Weather Service forecast grid. Look up the grid using the NWS points endpoint at https://api.weather.gov/points/{latitude},{longitude} and read forecastHourly. Forecast periods include temperature, wind and forecast text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| grid | Yes | Grid coordinates as one comma-separated path segment, such as 97,71. | |
| office | Yes | NWS forecast office identifier, such as LWX. |
pkulaw_post_account_get_points_balancePoints Balance Query — get_points_balanceInspect
Query Points Balance Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query Points Balance |
pkulaw_post_account_list_entitlementsQuery Points Balance — list_entitlementsInspect
List Service Enablement and Points Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | List Service Enablement and Points |
pkulaw_post_article_keyword_get_law_item_contentFind Statutory Articles Precisely—Keyword — get_law_item_contentInspect
, lease term, rent and rent payment deadlines...", Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | , lease term, rent and rent payment deadlines...", |
pkulaw_post_case_keyword_get_case_listJudicial Case Search - Keyword — get_case_listInspect
Keyword case search (including full element breakdown) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Keyword case search (including full element breakdown) |
pkulaw_post_case_number_recognition_anhao_recognitionCase Number Recognition and Source Tracing — anhao_recognitionInspect
Identify case numbers in text + standardized verification Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Identify case numbers in text + standardized verification |
pkulaw_post_case_semantic_search_caseSearch Judicial Cases — Semantic — search_caseInspect
Natural-language semantic case search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Natural-language semantic case search |
pkulaw_post_enforcement_search_enforcementSearch Administrative Enforcement — search_enforcementInspect
Administrative Enforcement Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Administrative Enforcement Search |
pkulaw_post_hyperlinks_get_linked_contentPKULaw Hyperlinks — get_linked_contentInspect
Add hyperlinks to an entire text in bulk Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Add hyperlinks to an entire text in bulk |
pkulaw_post_law_keyword_get_law_listSearch Statutes—Keyword — get_law_listInspect
Keyword statute-list search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Keyword statute-list search |
pkulaw_post_law_recognition_law_recognitionArticle Recognition and Source Tracing — law_recognitionInspect
Identify statutes in text + standardization Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Identify statutes in text + standardization |
pkulaw_post_law_semantic_get_articleSearch Statutes—Semantic — get_articleInspect
Precise query by law name + article number Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Precise query by law name + article number |
pkulaw_post_law_semantic_search_articleSearch Statutes — Semantic — search_articleInspect
Natural-language semantic search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Natural-language semantic search |
pkulaw_post_legal_search_anhao_recognitionIntelligent Legal Search — anhao_recognitionInspect
Identify case numbers in text and verify authenticity Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Identify case numbers in text and verify authenticity |
pkulaw_post_legal_search_diff_article_versionsIntelligent Legal Search — diff_article_versionsInspect
Differences Between Two Article Versions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Differences Between Two Article Versions |
pkulaw_post_legal_search_get_articleIntelligent Legal Search — get_articleInspect
Retrieve articles precisely by statute name + article number (preferred for article retrieval) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve articles precisely by statute name + article number (preferred for article retrieval) |
pkulaw_post_legal_search_get_article_historyIntelligent Legal Search — get_article_historyInspect
Article History Timeline Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Article History Timeline |
pkulaw_post_legal_search_get_case_listIntelligent Legal Search — get_case_listInspect
Keyword case search (exact filtering by reference level) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Keyword case search (exact filtering by reference level) |
pkulaw_post_legal_search_get_law_item_contentIntelligent Legal Search — get_law_item_contentInspect
Retrieve articles by numeric article number (complete metadata + article-level links) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve articles by numeric article number (complete metadata + article-level links) |
pkulaw_post_legal_search_get_law_listIntelligent Legal Search — get_law_listInspect
Keyword statute-list search (including metadata) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Keyword statute-list search (including metadata) |
pkulaw_post_legal_search_get_linked_contentIntelligent Legal Search — get_linked_contentInspect
Add hyperlinks to an entire text in bulk Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Add hyperlinks to an entire text in bulk |
pkulaw_post_legal_search_get_points_balanceIntelligent Legal Search — get_points_balanceInspect
Query points balance (0 points, placed last) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query points balance (0 points, placed last) |
pkulaw_post_legal_search_law_recognitionIntelligent Legal Search — law_recognitionInspect
Identify statutes in text and align them with standard names Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Identify statutes in text and align them with standard names |
pkulaw_post_legal_search_list_entitlementsIntelligent Legal Search — list_entitlementsInspect
List Service Enablement and Points (0 points, placed last) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | List Service Enablement and Points (0 points, placed last) |
pkulaw_post_legal_search_list_law_versionsIntelligent Legal Search — list_law_versionsInspect
Statute Version Chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Statute Version Chain |
pkulaw_post_legal_search_search_articleIntelligent Legal Search — search_articleInspect
Natural-language semantic article search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Natural-language semantic article search |
pkulaw_post_legal_search_search_caseIntelligent Legal Search — search_caseInspect
Natural-language semantic search for similar cases (preferred for finding similar cases) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Natural-language semantic search for similar cases (preferred for finding similar cases) |
pkulaw_post_legal_search_search_enforcementIntelligent Legal Search — search_enforcementInspect
Administrative Enforcement Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Administrative Enforcement Search |
pkulaw_post_legal_search_search_procuratorateIntelligent Legal Search — search_procuratorateInspect
Procuratorial Document Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Procuratorial Document Search |
pkulaw_post_procuratorate_search_procuratorateProcuratorate Document Search — search_procuratorateInspect
Procuratorial Document Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Procuratorial Document Search |
pkulaw_post_statute_history_diff_article_versionsStatute and Article History — diff_article_versionsInspect
Differences Between Two Article Versions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Differences Between Two Article Versions |
pkulaw_post_statute_history_get_article_historyStatute and Article History — get_article_historyInspect
Article History Timeline Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Article History Timeline |
pkulaw_post_statute_history_list_law_versionsStatute and Article History — list_law_versionsInspect
Statute Version Chain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Statute Version Chain |
polymarket_get_bookPolymarket — Get order bookInspect
Retrieves the order book summary for a specific token ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token ID (asset ID) |
polymarket_get_builder_tradesPolymarket — Get builder tradesInspect
Retrieves trades attributed to a builder code. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Trade ID to filter by specific trade | |
| after | No | Filter trades after this Unix timestamp | |
| before | No | Filter trades before this Unix timestamp | |
| market | No | Market (condition ID) to filter trades | |
| asset_id | No | Asset ID (token ID) to filter trades | |
| next_cursor | No | Cursor for pagination (base64 encoded offset) | |
| builder_code | Yes | Builder code to fetch attributed trades for |
polymarket_get_clob_markets_condition_idPolymarket — Get CLOB market infoInspect
Returns all CLOB-level parameters for a market in a single call — Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| condition_id | Yes | The condition ID of the market |
polymarket_get_commentsPolymarket — List commentsInspect
List comments Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| offset | No | offset | |
| ascending | No | ascending | |
| holders_only | No | holders_only | |
| get_positions | No | get_positions | |
| parent_entity_id | No | parent_entity_id | |
| parent_entity_type | No | parent_entity_type |
polymarket_get_comments_idPolymarket — Get comments by comment idInspect
Get comments by comment id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id | |
| get_positions | No | get_positions |
polymarket_get_comments_user_address_user_addressPolymarket — Get comments by user addressInspect
Get comments by user address Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| offset | No | offset | |
| ascending | No | ascending | |
| user_address | Yes | user_address |
polymarket_get_deployedPolymarket — Check if a wallet is deployedInspect
Returns whether the wallet at the given address is deployed onchain. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Wallet type to check. Defaults to `SAFE` when omitted. | |
| address | Yes | Address of the wallet to check |
polymarket_get_eventsPolymarket — List eventsInspect
List events Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | id | |
| cyom | No | cyom | |
| slug | No | slug | |
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| active | No | active | |
| closed | No | Filter by closed state. Omitted includes open and closed events. Use true for closed events, false for open events, or any (case-insensitive) for both states. Unlike markets, any does not require an identifier filter. Invalid closed values return 422. Import profile accepts the boolean branch only; other union branches are not exposed. | |
| offset | No | offset | |
| tag_id | No | tag_id | |
| archived | No | archived | |
| featured | No | featured | |
| tag_slug | No | tag_slug | |
| ascending | No | ascending | |
| recurrence | No | recurrence | |
| volume_max | No | volume_max | |
| volume_min | No | volume_min | |
| end_date_max | No | end_date_max | |
| end_date_min | No | end_date_min | |
| include_chat | No | include_chat | |
| related_tags | No | related_tags | |
| liquidity_max | No | liquidity_max | |
| liquidity_min | No | liquidity_min | |
| exclude_tag_id | No | exclude_tag_id | |
| start_date_max | No | start_date_max | |
| start_date_min | No | start_date_min | |
| include_template | No | include_template |
polymarket_get_events_id_comments_countPolymarket — Get event comment countInspect
Get event comment count Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_fee_ratePolymarket — Get fee rateInspect
Retrieves the base fee rate for a specific token ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | No | Token ID (asset ID) |
polymarket_get_fee_rate_token_idPolymarket — Get fee rate by path parameterInspect
Retrieves the base fee rate for a specific token ID using the token ID as a path parameter. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token ID (asset ID) |
polymarket_get_last_trade_pricePolymarket — Get last trade priceInspect
Retrieves the last trade price and side for a specific token ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token ID (asset ID) |
polymarket_get_marketsPolymarket — List marketsInspect
List markets Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | id | |
| cyom | No | cyom | |
| slug | No | slug | |
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| closed | No | Filter by closed state. Omitted or false returns open markets; true returns closed markets. Use any (case-insensitive) to include both states in an identifier lookup. Requires at least one of id, slug, clob_token_ids, position_ids, condition_ids, request_ids, onchain_event_ids, or question_ids when any is used. Each identifier filter accepts at most 100 values. Missing an identifier with any, or an invalid closed value, returns 422. Import profile accepts the boolean branch only; other union branches are not exposed. | |
| offset | No | offset | |
| tag_id | No | tag_id | |
| game_id | No | game_id | |
| ascending | No | ascending | |
| include_tag | No | include_tag | |
| end_date_max | No | end_date_max | |
| end_date_min | No | end_date_min | |
| question_ids | No | question_ids | |
| related_tags | No | related_tags | |
| condition_ids | No | condition_ids | |
| clob_token_ids | No | clob_token_ids | |
| start_date_max | No | start_date_max | |
| start_date_min | No | start_date_min | |
| volume_num_max | No | volume_num_max | |
| volume_num_min | No | volume_num_min | |
| rewards_min_size | No | rewards_min_size | |
| liquidity_num_max | No | liquidity_num_max | |
| liquidity_num_min | No | liquidity_num_min | |
| sports_market_types | No | sports_market_types | |
| uma_resolution_status | No | uma_resolution_status |
polymarket_get_markets_by_token_token_idPolymarket — Get market by tokenInspect
Returns the parent market for a given token ID. Useful when you have Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | The token ID to look up the parent market for |
polymarket_get_midpointPolymarket — Get midpoint priceInspect
Retrieves the midpoint price for a specific token ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token ID (asset ID) |
polymarket_get_neg_riskPolymarket — Get negative risk flagInspect
Retrieves the negative risk flag for a specific token ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | No | Token ID (asset ID) |
polymarket_get_neg_risk_token_idPolymarket — Get negative risk flag by path parameterInspect
Retrieves the negative risk flag for a specific token ID using the token ID as a path parameter. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token ID (asset ID) |
polymarket_get_noncePolymarket — Get current nonce for a userInspect
Gets the current Proxy or Safe nonce for a user. Takes in the user's signer address and the type of nonce to retrieve. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Type of nonce to retrieve | |
| address | Yes | User's signer address |
polymarket_get_pricePolymarket — Get market priceInspect
Retrieves the best market price for a specific token ID and side (bid or ask). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| side | Yes | Order side | |
| token_id | Yes | Token ID (asset ID) |
polymarket_get_prices_historyPolymarket — Get prices historyInspect
Retrieve historical price data for a market. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| endTs | No | Filter by items before this unix timestamp. | |
| market | Yes | The market (asset id) to query. | |
| startTs | No | Filter by items after this unix timestamp. | |
| fidelity | No | Accuracy of the data expressed in minutes. Default is 1 minute. | |
| interval | No | Time interval for data aggregation. |
polymarket_get_profiles_user_address_user_addressPolymarket — Get public profile by user addressInspect
Get public profile by user address Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_address | Yes | user_address |
polymarket_get_public_profilePolymarket — Get public profile by wallet addressInspect
Get public profile by wallet address Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | The wallet address (proxy wallet or user address) |
polymarket_get_public_searchPolymarket — Search markets, events, and profilesInspect
Search markets, events, and profiles Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | q | |
| page | No | page | |
| sort | No | sort | |
| cache | No | cache | |
| ascending | No | ascending | |
| optimized | No | optimized | |
| events_tag | No | events_tag | |
| recurrence | No | recurrence | |
| search_tags | No | search_tags | |
| events_status | No | events_status | |
| exclude_tag_id | No | exclude_tag_id | |
| limit_per_type | No | limit_per_type | |
| search_profiles | No | search_profiles | |
| keep_closed_markets | No | keep_closed_markets |
polymarket_get_query_market_discovery_get_event_by_id_cf500de4_iPolymarket — Get event by idInspect
Get event by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id | |
| include_chat | No | include_chat | |
| include_template | No | include_template |
polymarket_get_query_market_discovery_get_event_by_slug_53104e36Polymarket — Get event by slugInspect
Get event by slug Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | slug | |
| include_chat | No | include_chat | |
| include_template | No | include_template |
polymarket_get_query_market_discovery_get_event_creator_by_id_d5Polymarket — Get event creator by idInspect
Get event creator by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_query_market_discovery_get_event_tags_ef161323_idPolymarket — Get event tagsInspect
Get event tags Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_query_market_discovery_get_event_tweet_count_a76cPolymarket — Get event tweet countInspect
Get event tweet count Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_query_market_discovery_get_market_by_id_8bc925eePolymarket — Get market by idInspect
Get market by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id | |
| include_tag | No | include_tag |
polymarket_get_query_market_discovery_get_market_by_slug_f8868a3Polymarket — Get market by slugInspect
Get market by slug Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | slug | |
| include_tag | No | include_tag |
polymarket_get_query_market_discovery_get_market_description_byPolymarket — Get market description by idInspect
Get market description by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_query_market_discovery_get_market_tags_by_id_8edcPolymarket — Get market tags by idInspect
Get market tags by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_query_market_discovery_get_tag_by_slug_0733a7b9_sPolymarket — Get tag by slugInspect
Get tag by slug Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | slug | |
| include_template | No | include_template |
polymarket_get_query_market_discovery_list_event_creators_fe732dPolymarket — List event creatorsInspect
List event creators Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| offset | No | offset | |
| ascending | No | ascending | |
| creator_name | No | creator_name | |
| creator_handle | No | creator_handle |
polymarket_get_query_market_discovery_list_events_keyset_paginatPolymarket — List events (keyset pagination)Inspect
Returns events using cursor-based (keyset) pagination for stable, efficient paging through large result sets. Use next_cursor from each response as after_cursor in the next request. The offset parameter is explicitly rejected; use after_cursor instead. Anonymous native response captured; OpenAny gateway not yet executed.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | id | |
| cyom | No | cyom | |
| live | No | live | |
| slug | No | slug | |
| limit | No | Maximum number of results to return (max 100) | |
| order | No | Comma-separated list of JSON field names to order by | |
| closed | No | Filter by closed state. Omitted includes open and closed events. Use true for closed events, false for open events, or any (case-insensitive) for both states. Unlike markets, any does not require an identifier filter. Invalid closed values return 422. Import profile accepts the boolean branch only; other union branches are not exposed. | |
| locale | No | locale | |
| offset | No | Not allowed. Returns 422 if provided. | |
| tag_id | No | tag_id | |
| game_id | No | game_id | |
| featured | No | featured | |
| tag_slug | No | tag_slug | |
| ascending | No | Sort direction. Only used when order is set. | |
| series_id | No | series_id | |
| tag_match | No | tag_match | |
| created_by | No | created_by | |
| event_date | No | event_date | |
| event_week | No | event_week | |
| recurrence | No | recurrence | |
| volume_max | No | volume_max | |
| volume_min | No | volume_min | |
| after_cursor | No | Opaque cursor token from a previous response's next_cursor | |
| end_date_max | No | end_date_max | |
| end_date_min | No | end_date_min | |
| include_chat | No | When true, includes Chats and Series.Chats relations | |
| partner_slug | No | When set, external_partners are attached to matching events | |
| related_tags | No | related_tags | |
| title_search | No | title_search | |
| liquidity_max | No | liquidity_max | |
| liquidity_min | No | liquidity_min | |
| exclude_tag_id | No | Tag IDs to exclude. Cannot overlap with tag_id. | |
| featured_order | No | featured_order | |
| start_date_max | No | start_date_max | |
| start_date_min | No | start_date_min | |
| start_time_max | No | start_time_max | |
| start_time_min | No | start_time_min | |
| parent_event_id | No | parent_event_id | |
| include_children | No | include_children | |
| include_template | No | When true, includes Templates relation | |
| include_best_lines | No | When true, includes BestLines relation |
polymarket_get_query_market_discovery_list_events_paginated_f118Polymarket — List events (paginated)Inspect
List events (paginated) Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| offset | No | offset | |
| ascending | No | ascending | |
| recurrence | No | recurrence | |
| include_chat | No | include_chat | |
| include_template | No | include_template |
polymarket_get_query_market_discovery_list_markets_keyset_paginaPolymarket — List markets (keyset pagination)Inspect
Returns markets using cursor-based (keyset) pagination for stable, efficient paging through large result sets. Use next_cursor from each response as after_cursor in the next request. The offset parameter is explicitly rejected; use after_cursor instead. Anonymous native response captured; OpenAny gateway not yet executed.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | id | |
| cyom | No | cyom | |
| slug | No | slug | |
| limit | No | Maximum number of results to return (max 100) | |
| order | No | Comma-separated list of JSON field names to order by, e.g. volume_num,liquidity_num | |
| closed | No | Filter by closed state. Omitted or false returns open markets; true returns closed markets. Use any (case-insensitive) to include both states in an identifier lookup. Requires at least one of id, slug, clob_token_ids, position_ids, condition_ids, request_ids, onchain_event_ids, or question_ids when any is used. Each identifier filter accepts at most 100 values. Missing an identifier with any, or an invalid closed value, returns 422. Import profile accepts the boolean branch only; other union branches are not exposed. | |
| locale | No | locale | |
| offset | No | Not allowed. Returns 422 if provided. | |
| tag_id | No | tag_id | |
| game_id | No | game_id | |
| ascending | No | Sort direction. Only used when order is set. | |
| tag_match | No | tag_match | |
| decimalized | No | decimalized | |
| include_tag | No | When true, includes Tags relation on each market | |
| rfq_enabled | No | rfq_enabled | |
| after_cursor | No | Opaque cursor token from a previous response's next_cursor | |
| end_date_max | No | end_date_max | |
| end_date_min | No | end_date_min | |
| question_ids | No | question_ids | |
| related_tags | No | related_tags | |
| condition_ids | No | condition_ids | |
| clob_token_ids | No | clob_token_ids | |
| start_date_max | No | start_date_max | |
| start_date_min | No | start_date_min | |
| volume_num_max | No | volume_num_max | |
| volume_num_min | No | volume_num_min | |
| liquidity_num_max | No | liquidity_num_max | |
| liquidity_num_min | No | liquidity_num_min | |
| sports_market_types | No | sports_market_types | |
| uma_resolution_status | No | uma_resolution_status |
polymarket_get_query_market_discovery_list_sport_events_resultsPolymarket — List sport events resultsInspect
List sport events results Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| offset | No | offset | |
| ascending | No | ascending |
polymarket_get_query_orderbook_and_prices_get_current_active_rewPolymarket — Get current active rewards configurationsInspect
Returns all current active rewards configurations grouped by market. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sponsored | No | If true, returns sponsored reward configurations instead of standard ones | |
| next_cursor | No | Pagination cursor from previous response |
polymarket_get_query_orderbook_and_prices_get_live_activity_markPolymarket — Get live activity market by condition IDInspect
Returns minimal market information optimized for live activity widgets (e.g., iOS Live Activities, Android widgets) Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| condition_id | Yes | The condition ID of the market |
polymarket_get_query_orderbook_and_prices_get_multiple_markets_wPolymarket — Get multiple markets with rewardsInspect
Returns a list of active markets with their reward configurations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Text search on market question/description | |
| event_id | No | Filter by event ID. Can be repeated for multiple events (e.g., ?event_id=100&event_id=200) | |
| order_by | No | Field to sort results by | |
| position | No | Sort direction | |
| tag_slug | No | Filter by tag slug. Can be repeated for OR logic (e.g., ?tag_slug=sports&tag_slug=politics) | |
| max_price | No | Maximum first token price filter | |
| min_price | No | Minimum first token price filter | |
| page_size | No | Number of items per page (max 500, values above are capped) | |
| max_spread | No | Maximum spread filter | |
| min_spread | No | Minimum spread filter | |
| event_title | No | Search event titles using case-insensitive pattern matching | |
| next_cursor | No | Pagination cursor from previous response | |
| max_volume_24hr | No | Maximum 24-hour volume filter | |
| min_volume_24hr | No | Minimum 24-hour volume filter |
polymarket_get_query_orderbook_and_prices_get_raw_rewards_for_aPolymarket — Get raw rewards for a specific marketInspect
Returns an array of present and future rewards configured on a market. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sponsored | No | If true, folds sponsored daily rates into each config's rate_per_day | |
| next_cursor | No | Pagination cursor from previous response | |
| condition_id | Yes | The condition ID of the market |
polymarket_get_rebates_currentPolymarket — Get current rebated fees for a makerInspect
Returns the current rebated fees for a maker address on a given date. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | Date in YYYY-MM-DD format | |
| maker_address | Yes | Ethereum address of the maker |
polymarket_get_relay_payloadPolymarket — Get relayer address and nonceInspect
Fetches the relayer address and nonce for a specific user. Takes in the user's signer address and the type of nonce to retrieve. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Type of nonce to retrieve | |
| address | Yes | User's signer address |
polymarket_get_sampling_marketsPolymarket — Get sampling marketsInspect
Get sampling markets Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| next_cursor | No | next_cursor |
polymarket_get_sampling_simplified_marketsPolymarket — Get sampling simplified marketsInspect
Get sampling simplified markets Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| next_cursor | No | next_cursor |
polymarket_get_seriesPolymarket — List seriesInspect
List series Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | slug | |
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| closed | No | closed | |
| offset | No | offset | |
| ascending | No | ascending | |
| recurrence | No | recurrence | |
| include_chat | No | include_chat | |
| categories_ids | No | categories_ids | |
| exclude_events | No | exclude_events | |
| categories_labels | No | categories_labels |
polymarket_get_series_idPolymarket — Get series by idInspect
Get series by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id | |
| include_chat | No | include_chat |
polymarket_get_series_id_comments_countPolymarket — Get series comment countInspect
Get series comment count Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_series_summary_idPolymarket — Get series summary by idInspect
Get series summary by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_series_summary_slug_slugPolymarket — Get series summary by slugInspect
Get series summary by slug Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | slug |
polymarket_get_simplified_marketsPolymarket — Get simplified marketsInspect
Get simplified markets Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| next_cursor | No | next_cursor |
polymarket_get_sportsPolymarket — Get sports metadata informationInspect
Get sports metadata information Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_sports_market_typesPolymarket — Get valid sports market typesInspect
Get valid sports market types Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_spreadPolymarket — Get spreadInspect
Retrieves the spread for a specific token ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token ID (asset ID) |
polymarket_get_supported_assetsPolymarket — Get supported assetsInspect
Get supported assets Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_tagsPolymarket — List tagsInspect
List tags Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| offset | No | offset | |
| ascending | No | ascending | |
| is_carousel | No | is_carousel | |
| include_template | No | include_template |
polymarket_get_tags_idPolymarket — Get tag by idInspect
Get tag by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id | |
| include_template | No | include_template |
polymarket_get_teamsPolymarket — List teamsInspect
List teams Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | name | |
| limit | No | limit | |
| order | No | Comma-separated list of fields to order by | |
| league | No | league | |
| offset | No | offset | |
| ascending | No | ascending | |
| abbreviation | No | abbreviation |
polymarket_get_teams_idPolymarket — Get team by idInspect
Get team by id Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id |
polymarket_get_tick_sizePolymarket — Get tick sizeInspect
Retrieves the minimum tick size (price increment) for a specific token ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | No | Token ID (asset ID) |
polymarket_get_tick_size_token_idPolymarket — Get tick size by path parameterInspect
Retrieves the minimum tick size (price increment) for a specific token ID using the token ID as a path parameter. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token ID (asset ID) |
polymarket_get_v1_info_assetsPolymarket — Get Collateral AssetsInspect
Get a list of collateral assets. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_v1_info_bboPolymarket — Get BBOInspect
Get best bid and offer for all instruments. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| instrument_id | No | Instrument ID |
polymarket_get_v1_info_bookPolymarket — Get BookInspect
Get book for an instrument. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | Number of book levels to return | |
| instrument_id | Yes | Instrument ID |
polymarket_get_v1_info_builderPolymarket — Get builder profile and eligibilityInspect
Public builder profile for an address. Returns the saved display name and Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Address |
polymarket_get_v1_info_competitionPolymarket — Get Trading CompetitionInspect
Settings, status and prize table of one competition: its markets and Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| competition_id | Yes | Trading competition ID |
polymarket_get_v1_info_competition_accountPolymarket — Get Trading Competition AccountInspect
One account's standing: rank and score once qualified, otherwise its Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Address | |
| competition_id | Yes | Trading competition ID |
polymarket_get_v1_info_competition_leaderboardPolymarket — Get Trading Competition LeaderboardInspect
Ranked leaderboard rows at any depth. Only accounts that reached the Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of entries to return | |
| offset | No | Number of entries to skip | |
| competition_id | Yes | Trading competition ID |
polymarket_get_v1_info_competitionsPolymarket — Get Trading CompetitionsInspect
List trading competitions for the carousel, newest first, with the live Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | No | Address |
polymarket_get_v1_info_competition_widgetPolymarket — Get Trading Competition WidgetInspect
The live competition at a glance for the trading page: when it ends, Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | No | Address |
polymarket_get_v1_info_exchangePolymarket — Get Exchange InfoInspect
Get exchange information. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_v1_info_exchange_statsPolymarket — Get Exchange StatisticsInspect
Get aggregate statistics for all pUSD-quoted Polymarket perpetual markets. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_timestamp | Yes | End timestamp in milliseconds | |
| start_timestamp | Yes | Start timestamp in milliseconds |
polymarket_get_v1_info_feesPolymarket — Get FeesInspect
Get the fee tier schedule for each instrument type and category. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_v1_info_fundingPolymarket — Get Historical FundingInspect
Get public funding rate history for an instrument. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_timestamp | No | End timestamp in milliseconds | |
| instrument_id | Yes | Instrument ID | |
| start_timestamp | No | Start timestamp in milliseconds |
polymarket_get_v1_info_indexPolymarket — Get IndexInspect
Get index price and the list of constituents for an asset. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | Yes | Asset name |
polymarket_get_v1_info_instrumentsPolymarket — Get InstrumentsInspect
Get enabled instruments. When instrument_id is supplied, a permanently settled instrument is also returned, including its final settlement record. Other disabled instruments remain excluded. The presence of settlement means the instrument is delisted and cannot trade. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | Instrument category | |
| instrument_id | No | Instrument ID | |
| instrument_type | No | Instrument type |
polymarket_get_v1_info_invitePolymarket — Check Invite CodeInspect
Check whether an invite code can be used. When address is provided, the
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Referral or invite code | |
| address | No | Address |
polymarket_get_v1_info_klinesPolymarket — Get KlinesInspect
Get klines for an instrument. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| interval | Yes | Kline interval | |
| end_timestamp | No | End timestamp in milliseconds | |
| instrument_id | Yes | Instrument ID | |
| start_timestamp | Yes | Start timestamp in milliseconds |
polymarket_get_v1_info_leaderboardPolymarket — Get LeaderboardInspect
Get the global perpetuals leaderboard, ranked by PnL, notional volume, Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of entries to return | |
| offset | No | Number of entries to skip | |
| window | No | Leaderboard window, anchored to calendar UTC boundaries. `day` starts at 00:00 UTC today, `week` at Monday 00:00 UTC, `month` at the first of the month 00:00 UTC, `all` at exchange launch. | |
| address | No | Address | |
| sort_by | No | Leaderboard ranking metric |
polymarket_get_v1_info_limit_tiersPolymarket — Get Limit TiersInspect
Get the list of account limit tiers. Action and open-order fields are enforced per account; legacy request-rate fields are not used for gateway request enforcement. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_v1_info_mark_historyPolymarket — Get Mark Price HistoryInspect
Get mark price history for an instrument, bucketed by interval. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| interval | Yes | Kline interval | |
| end_timestamp | No | End timestamp in milliseconds | |
| instrument_id | Yes | Instrument ID | |
| start_timestamp | Yes | Start timestamp in milliseconds |
polymarket_get_v1_info_portfolioPolymarket — Get Public PortfolioInspect
Get public portfolio for an address including equity and open positions. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Address |
polymarket_get_v1_info_position_fillsPolymarket — Get Current Position FillsInspect
Get every fill in a registered account's current open position cycle for Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Time sort direction. `desc` (default) returns newest fills first; `asc` returns oldest first. | |
| cursor | No | Opaque keyset pagination cursor for the next page of fills. Present while `more` is true; pass it as `cursor` on the next request, keeping the other parameters the same across pages. | |
| address | Yes | Address | |
| instrument_id | Yes | Instrument ID |
polymarket_get_v1_info_registeredPolymarket — Get RegistrationInspect
Check whether an address has a Perps account. Registration is permanent, Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Address |
polymarket_get_v1_info_statisticsPolymarket — Get StatisticsInspect
Get last 24-hour statistics for all instruments. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| instrument_id | No | Instrument ID |
polymarket_get_v1_info_tickersPolymarket — Get TickersInspect
Get all instrument tickers with live market data. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| instrument_id | No | Instrument ID |
polymarket_get_v1_info_tradesPolymarket — Get Recent TradesInspect
Get public trades for an instrument. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_timestamp | No | End timestamp in milliseconds | |
| instrument_id | Yes | Instrument ID | |
| start_timestamp | No | Start timestamp in milliseconds |
polymarket_get_v1_rfq_combo_marketsPolymarket — Get combo marketsInspect
Returns active markets that can be used as combo legs, ordered by volume Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of markets to return. Defaults to `50`; maximum `100`. | |
| cursor | No | Opaque cursor returned as `next_cursor` by the previous response. | |
| exclude | No | Comma-separated condition IDs to omit, such as markets already shown. |
polymarket_get_v2_activityPolymarket — List account activityInspect
Keyset-paginated activity feed (trades, splits, merges, Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Window end, epoch seconds (inclusive); omitted or `0` means now plus one day. | |
| side | No | BUY or SELL. | |
| type | No | Activity type(s), comma-separated. Accepted values: `TRADE`, `SPLIT`, `MERGE`, `REDEEM` (automatic redemptions included), `CONVERSION`, `MIGRATION`, `REWARD`, `YIELD`, `MAKER_REBATE`, `TAKER_REBATE`, `REFERRAL_REWARD`, `DEPOSIT`, `WITHDRAWAL`, `TIP`. Any other value is rejected with `400`. Omitted, the feed returns every type except `TIP`. `DEPOSIT` and `WITHDRAWAL` rows are returned only with `exclude_deposits_withdrawals=false`. Under its default (`true`) they are dropped even when named here, so `type=DEPOSIT` or `type=WITHDRAWAL` alone returns an empty page. `TIP` is **opt-in**: it is never in the default set, so it is only returned when you name it here. A tip is a user↔user pUSD transfer that is not a trade-settlement leg; `size` is the amount and `side` carries the direction (`IN` received / `OUT` sent). | |
| user | Yes | Required; the feed is user-anchored. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| limit | No | Page size; default 100, max 1000, past-cap rejected. | |
| start | No | Window start on `block_timestamp`, epoch seconds (inclusive). Omitted or `0` floors to three years back; pass `start=1` for full history. | |
| cursor | No | Opaque cursor from a prior response's `next_cursor`; binds the sort direction it was minted under. | |
| sort_by | No | Only `TIMESTAMP` is supported (v2 pages by keyset). | |
| event_id | No | Gamma event id(s), comma-separated (at most 20 distinct values); resolves to the events' markets. Mutually exclusive with `condition`. | |
| condition | No | Condition id(s), comma-separated (at most 20 distinct values). `condition_id` / `conditionId` are accepted aliases. | |
| sort_direction | No | `ASC` or `DESC` (default). The keyset seeks in the chosen direction; the minted cursor binds it, so pass it consistently when paging. | |
| exclude_deposits_withdrawals | No | Defaults to `true`, which drops `DEPOSIT` and `WITHDRAWAL` rows from the page, including when `type` names them. Pass `false` to include them. |
polymarket_get_v2_activity_combosPolymarket — List combo activityInspect
Keyset-paginated combo lifecycle + redemption Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | Required; the feed is user-anchored. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| limit | No | First-page size. Ignored when `cursor` is supplied. | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. | |
| condition | No | Combo condition id(s), comma-separated (at most 20 distinct values). `condition_id` / `conditionId` are accepted aliases. |
polymarket_get_v2_approvalsPolymarket — Get wallet approvalsInspect
Polygon token/operator approval state for one wallet. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | The proxy wallet whose approval state to return. Required EVM address. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. |
polymarket_get_v2_biggest_winnersPolymarket — List the biggest winsInspect
The biggest single winning positions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | First-page size. Ignored when `cursor` is supplied. | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. | |
| category | No | `overall` (default), a Gamma market category (e.g. `sports`), or a synthetic category: `combos` (combinatorial wins get their own full top-500 per window) or `esports` (promoted subcategory). | |
| time_period | No | Window on `resolved_at`: `day` | `week` | `month` | `all`. Defaults to `day`. |
polymarket_get_v2_builders_leaderboardPolymarket — Get the builders leaderboardInspect
The ranked board of builders by volume. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | First-page size. Ignored when `cursor` is supplied. | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. | |
| time_period | No | Window: `day` | `week` | `month` | `all`. Defaults to `day`. |
polymarket_get_v2_builders_volumePolymarket — Get builder volume over timeInspect
The per-builder volume time series. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many of the most recent buckets to return. Defaults to 30, capped at 90; a lower ceiling than the rest of the surface, because only ~308 daily buckets exist and the family maximum would return the whole series. Bounds BUCKETS, not rows: a row limit would cut a bucket in half and leave a partial period in the series. | |
| interval | No | Bucket width: `day` | `week` | `month` | `all`. Defaults to `day`. `timePeriod` and `time_period` are accepted aliases. |
polymarket_get_v2_holdersPolymarket — List a market's top holdersInspect
Top holders of a market, netted per user and grouped by Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows per outcome token; defaults to 100, maximum 1000 (100 with `include_pnl=true`). | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`; carries the per-token `(limit, offset)` window and overrides `limit`. Paging past the first page is cursor-only. | |
| condition | Yes | Comma-separated `condition_id`s (at most 20 distinct values; exactly one with `include_pnl=true`). Required. `condition` is the unified key across v2 (same as the feeds and `/v2/oi`); `condition_id` / `conditionId` are accepted aliases. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| include_pnl | No | Opt into per-holder position economics (default `false`; `includePnl` is an accepted alias). Adds `avg_price`, `entry_cost_usdc`, `current_price`, `current_value`, `realized_pnl`, `unrealized_pnl` and `total_pnl` to every holder row, and switches the served amounts to per-side gross balances: a wallet holding both outcomes appears under both tokens with per-side sizes and that side's economics, matching `/v2/positions` for the same wallet and token. This mode serves one market's table at a time: exactly one `condition`, `limit` at most 100. | |
| min_balance | No | Minimum net balance in shares (default 0), applied post-netting. With `include_pnl=true` it applies to the served per-side gross amount instead. |
polymarket_get_v2_leaderboardPolymarket — Get the trader leaderboardInspect
The ranked board of realized PnL, combos included. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | No | Look up one wallet's standing instead of reading the board. Returns a single object carrying both ranks, not a page. | |
| limit | No | First-page size. Ignored when `cursor` is supplied. | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. | |
| sort_by | No | Which board: `PNL` (default) or `VOLUME`. | |
| category | No | `overall` (default), a Gamma market category (e.g. `sports`), or a synthetic category: `combos` (combinatorial positions; PNL boards only; the volume board has no combos rows) or `esports` (promoted subcategory). | |
| time_period | No | Window: `day` | `week` | `month` | `all`. Defaults to `day`. |
polymarket_get_v2_live_volumePolymarket — Get live volume for an eventInspect
Cumulative one-side (taker) volume per market. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| event_id | Yes | Event id(s), comma-separated (at most 20 distinct values). Required. `event_id` is the unified key across v2 (same as the feeds); `id` and `eventId` are accepted aliases. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. |
polymarket_get_v2_oiPolymarket — Get open interestInspect
Priced gross open interest per market. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| condition | Yes | Condition id(s), comma-separated (at most 20 distinct values). `condition` is the unified key across v2 (same as the feeds); `condition_id` / `conditionId` are accepted aliases. Omit for global open interest. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. |
polymarket_get_v2_positionsPolymarket — List positions for a user or marketInspect
A keyset page of positions in the standard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Inclusive upper bound on `last_event_at`, epoch seconds; omit or `0` for unbounded. A position with no native economics carries no `last_event_at` and is therefore **excluded by any bound**, in either direction; a window asks which positions moved inside it, and a row with no clock has no answer. Unbounded requests still serve those rows. | |
| user | Yes | The wallet to anchor on. At least one of `user`/`condition` is required. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| limit | No | First-page size. Ignored when `cursor` is supplied (the cursor's size wins). | |
| start | No | Inclusive lower bound on `last_event_at`, epoch seconds; omit or `0` for unbounded (the `/v2/activity` + `/v2/trades` vocabulary). | |
| title | No | Case-insensitive market-title substring filter, honoured on every anchor and status. SQL LIKE wildcards (`%`, `_`) keep their usual meaning; empty or whitespace-only is treated as absent; at most 200 characters. NOT carried by the cursor: re-send it on every page of a walk (like `condition` and the `start`/`end` window), or the cohort silently widens. | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. It carries the page position, page size, and the status/sort/direction it was minted under. | |
| status | No | One of `OPEN`, `REDEEMABLE`, `REDEEMABLE_LOST`, `MERGEABLE`, or `CLOSED`; defaults to `OPEN`. `REDEEMABLE_LOST` requires `user`, supports all six sorts, and defaults to `CURRENT_VALUE`; it preserves row status `REDEEMABLE`. `MERGEABLE` is `OPEN` narrowed to live complementary pairs (conditions where the wallet holds >= 2 servable-live tokens) and defaults to `TOKENS`; it is user-scoped, so a market-anchored request renders as `OPEN`. `OPEN` is the superset; it includes settled-but-unredeemed winners, which `REDEEMABLE` narrows to. `CLOSED` is exited positions. | |
| sort_by | No | One of `CURRENT_VALUE`, `PRICE`, `TOKENS`, `UNREALIZED_PNL`, `REALIZED_PNL`, `TOTAL_PNL`, or `TIMESTAMP` (the row's `last_event_at`). `PRICE` ranks by the response's effective `current_price` on every supported anchor and status. On `REDEEMABLE`, the existing winners-first partition remains ahead of the requested price order. The default follows the status: `CURRENT_VALUE` for `OPEN`/`REDEEMABLE`, `REALIZED_PNL` for `CLOSED`. On a user's `CLOSED` positions, `TOKENS`, `CURRENT_VALUE`, `PRICE` and `UNREALIZED_PNL` describe a holding that no longer exists, so those pages are served in `REALIZED_PNL` order. | |
| event_id | No | Event id(s), comma-separated (at most 20 distinct values). User-anchored only. | |
| condition | No | Condition id(s), comma-separated (at most 20 distinct values). With `user`, narrows that user's positions (all ids honoured). Without `user`, anchors on the market's holders; exactly one id is accepted there, and a multi-id list is rejected rather than silently truncated. | |
| filter_type | No | `CASH` or `TOKENS`; defaults to `TOKENS` (the /v2/trades-homogenized filter pair, replacing the former `size_threshold`). | |
| filter_amount | No | The filter floor. `TOKENS`: minimum CURRENT holding in shares (defaults to the 0.1 dust floor; applies to `OPEN`/`REDEEMABLE`; a user's `CLOSED` set is not narrowed by it, and on a market anchor it moves the OPEN/CLOSED boundary). `CASH`: minimum mark-to-market `current_value` in USDC, on top of the token dust floor. Invalid values fall back to the default. | |
| sort_direction | No | `ASC` or `DESC`; defaults to `DESC`. | |
| include_archived | No | Also include positions on archived markets; defaults to `false`. `OPEN`/`REDEEMABLE`/`REDEEMABLE_LOST`/`MERGEABLE` only; combining it with `status=CLOSED` is rejected. Inactive markets remain excluded either way. |
polymarket_get_v2_positions_combosPolymarket — List combo positionsInspect
Combo positions for a user, in the standard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | The wallet to anchor on. Required; combo positions are user-anchored. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| limit | No | First-page size. Ignored when `cursor` is supplied (the cursor's size wins). | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. | |
| status | No | One of `OPEN`, `REDEEMABLE`, `PARTIAL`, `RESOLVED_WIN`, `RESOLVED_LOSS`, `RESOLVED_PARTIAL`; default (absent) is the held-visibility listing. Aligned with `/v2/positions`: `OPEN` is the superset; it includes still-held redeemable positions; and `REDEEMABLE` narrows to exactly the rows whose `redeemable` flag is `true`. `REDEEMABLE` must be the sole value; the other values may be combined comma-separated and keep per-value equality semantics. | |
| sort_by | No | `FIRST_ENTRY` (default, except under `status=REDEEMABLE`, which defaults to `ENTRY_COST` so the largest claims lead) | `ENTRY_COST` | `CURRENT_VALUE` (alias of `ENTRY_COST`) | `UPDATED`. `FIRST_ENTRY DESC` and `UPDATED ASC` page by keyset; every other combination pages by an offset-shaped cursor. The minted cursor binds sort + direction along with the `status`/`condition` cohort, so a page-2 request needs only `?user=` and `?cursor=`; restating a filter is allowed but must agree. | |
| condition | No | Combo condition id(s), comma-separated (at most 20 distinct values). `condition_id` / `conditionId` are accepted aliases. | |
| updated_after | No | Incremental-sync watermark: INCLUSIVE lower bound on `updated_at`, epoch seconds. Without a `status` filter, either watermark serves the sync view; every live row (mirror-complete), not only the held listing; a `status` filter keeps its own row visibility. The window's upper end is always capped by a short stability ceiling (about 90 seconds behind now), so a bound in the future cannot serve rows that may still move. | |
| sort_direction | No | `ASC` or `DESC` (default `DESC`). | |
| updated_before | No | Incremental-sync watermark: INCLUSIVE upper bound on `updated_at`, epoch seconds; must not precede `updated_after`. See `updated_after` for the sync-view and ceiling semantics. |
polymarket_get_v2_prices_historyPolymarket — Get a token's price historyInspect
The price-history series for one outcome token, or Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Window end, epoch seconds, EXCLUSIVE. Requires `start`; on its own it would ask for every point ever recorded up to `end`. | |
| as_of | No | Point-in-time read, epoch seconds, INCLUSIVE: the latest observation at or before this instant. Cannot be combined with a window. `asOf` is an accepted alias. | |
| limit | No | First-page size; defaults to the cap (10,000). Ignored when `cursor` is supplied (the cursor's size wins). | |
| start | No | Window start, epoch seconds, INCLUSIVE. Alone it means "up to the present", and is capped at 15 days back from now. Pass `end` too when paging: a window that tracks the present keeps growing at the tip, and the 15-day cap is re-checked on every page, so a walk that starts near the cap can outlive it. | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. | |
| interval | No | Relative window INSTEAD of `start`/`end`: `max`, `all`, `1m`, `1w`, `1d`, `6h`, `1h`, matched case-sensitively. An empty `interval=` is a malformed value, not an absent one. `max`/`all` serve the market's WHOLE life (back to 2022 for the oldest markets) at 12-hour buckets by default; at `bucket_seconds` of 10800 or 43200 the window is unbounded, while finer widths keep a 30-day window. The other intervals take a width sized to their own span when `bucket_seconds` is omitted (`1h`/`6h`/`1d` 60, `1w` 300, `1m` 1800), and each still floors an explicit value: 600 for `max`/`all`/`1m`, 300 for `1w`. | |
| token_id | Yes | Outcome token id (the CLOB asset id the chart is keyed by). Required. `tokenId` is an accepted alias. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| bucket_seconds | No | Bucket width in SECONDS (60…86400). `bucketSeconds` is an accepted alias. OMIT it and the server sizes the width to the window: the finest tier grain (60, 300, 1800, 10800, 43200) that keeps the series under ~2,500 points, except that an explicit window wider than 12 hours never defaults to the 60s grain (send `bucket_seconds=60` when you want second-by-minute detail over a longer window), and coarsened further if that grain no longer reaches the window's start. So a window up to 12 hours keeps 1-minute detail, half a day through a week defaults to 300, fifteen days to 1800; interval presets keep their own span-derived defaults (`1d` 60s, `1w` 300, `1m` 1800, and the unbounded `max`/`all` 43200). SEND it and it is served exactly as asked, which for a window older than that resolution's retention means an empty page rather than a silent substitution. An explicit value is also floored per interval: 600 for `max`/`all`/`1m`, 300 for `1w`. |
polymarket_get_v2_resolutionsPolymarket — Get resolution stateInspect
Complete resolution state by one selector family. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| condition | Yes | Comma-separated Gamma condition identifiers (at most 20 distinct values). This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. |
polymarket_get_v2_statusPolymarket — Get data freshnessInspect
How fresh the data behind this API is. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
polymarket_get_v2_tokensPolymarket — Look up tokensInspect
Resolves token ids, or the tokens of conditions, to their condition, Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| token_id | Yes | Token id(s), comma-separated (at most 50 distinct values): decimal ERC-1155 ids as they appear on receipts and on the `token_id` and `asset` fields of the other routes. Elements are trimmed, leading zeros stripped and duplicates collapsed to their first position. `token_ids` is an accepted alias. Exactly one of `token_id` and `condition` is required. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. |
polymarket_get_v2_tradesPolymarket — List tradesInspect
Keyset-paginated trade feed in the standard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Window end, epoch seconds (inclusive); honored on the `user` shape only; omitted or `0` means now plus one day. | |
| side | No | BUY or SELL. | |
| user | No | Address to filter by; omit for the market/event/global feed. | |
| limit | No | First-page size. Ignored when `cursor` is supplied (the cursor's size wins). | |
| start | No | Window start on `block_timestamp`, epoch seconds (inclusive); honored on the `user` shape only. Omitted or `0` floors to three years back; `start=1` asks for full history. The `condition`/`event_id` shapes serve a fixed three-year window and the bare feed the rolling current-plus-previous month, ignoring both bounds. | |
| cursor | No | Opaque pagination cursor from a prior response's `next_cursor`. | |
| event_id | No | Event id(s), comma-separated (at most 20 distinct values). | |
| condition | No | Condition id(s), comma-separated (at most 20 distinct values). `condition_id` / `conditionId` are accepted aliases. | |
| taker_only | No | Defaults to `true`: each fill is served once, on its taker side. `false` includes the maker rows too. | |
| filter_type | No | CASH or TOKENS; defaults to TOKENS. | |
| filter_amount | No | Minimum trade size; defaults to 0.01, and 0 means the same. |
polymarket_get_v2_user_pnlPolymarket — Get a user's PnL seriesInspect
Complete cumulative native-PnL atoms and compositions. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | Proxy wallet. The `user_address` spelling is accepted as an alias. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| fidelity | No | Output grid: `1d`, `18h`, `12h`, `3h`, or `1h`. Defaults to `1h`. | |
| interval | No | Window: `max`, `all`, `1m`, `1w`, `1d`, `12h`, or `6h`. Defaults to `1d`. |
polymarket_get_v2_user_statsPolymarket — Get a user's profile statsInspect
The profile card for one wallet in a single call. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | The wallet whose profile stats to return. Required; `0x` followed by 40 hexadecimal characters. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. |
polymarket_get_v2_user_volumePolymarket — Get a user's trading volumeInspect
One wallet's trading volume over a window, in both Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Window end, epoch seconds, inclusive, floored to its UTC day. Omitted or `0` disables the bound. | |
| user | Yes | The wallet whose volume to return. Required. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| start | No | Window start, epoch seconds, inclusive. Omitted or `0` disables the bound (the feeds' convention). Volume is tracked in whole UTC days, so the bound is floored to its UTC day. |
polymarket_get_v2_valuePolymarket — Get portfolio valueInspect
The user's portfolio value: single-market holdings marked to market plus Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | The wallet whose portfolio value to return. Required. This execution profile requires an explicit non-null value. The original optional/nullable OpenAPI declarations remain in officialOperation. | |
| condition | No | Comma-separated `condition_id`s (at most 20 distinct values); omit for the full portfolio. |
polymarket_post_batch_prices_historyPolymarket — Get batch prices historyInspect
Retrieve historical price data for multiple markets in a single request. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get batch prices history — complete native JSON request body. |
polymarket_post_booksPolymarket — Get order books (request body)Inspect
Retrieves order book summaries for multiple token IDs using a request body. Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get order books (request body) — complete native JSON request body. |
polymarket_post_last_trades_pricesPolymarket — Get last trade prices (request body)Inspect
Retrieves last trade prices for multiple token IDs using a request body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get last trade prices (request body) — complete native JSON request body. |
polymarket_post_markets_abridgedPolymarket — Query abridged markets by information filtersInspect
Query abridged markets by information filters Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query abridged markets by information filters — complete native JSON request body. |
polymarket_post_markets_informationPolymarket — Query markets by information filtersInspect
Query markets by information filters Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Query markets by information filters — complete native JSON request body. |
polymarket_post_markets_live_activityPolymarket — Get live activity markets by condition IDsInspect
Returns minimal market information for multiple markets, optimized for live activity widgets (e.g., iOS Live Activities, Android widgets) Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get live activity markets by condition IDs — complete native JSON request body. |
polymarket_post_midpointsPolymarket — Get midpoint prices (request body)Inspect
Retrieves midpoint prices for multiple token IDs using a request body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get midpoint prices (request body) — complete native JSON request body. |
polymarket_post_pricesPolymarket — Get market prices (request body)Inspect
Retrieves market prices for multiple token IDs and sides using a request body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get market prices (request body) — complete native JSON request body. |
polymarket_post_quotePolymarket — Get a quoteInspect
Get a quote Anonymous native response captured; OpenAny gateway not yet executed. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get a quote — complete native JSON request body. |
polymarket_post_spreadsPolymarket — Get spreadsInspect
Retrieves spreads for multiple token IDs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get spreads — complete native JSON request body. |
polymarket_post_v1_info_position_snapshotsPolymarket — Get Position Share Card SnapshotsInspect
Build share-card numbers, candles and trade markers for a registered account. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Get Position Share Card Snapshots — complete native JSON request body. |
qcc_post_case_get_judicial_authoritative_case_searchQCC — Authoritative Case Keyword SearchInspect
Search authoritative guiding, gazette, typical, database-selected, and reference cases, including judgment summaries. Authoritative cases are searched separately from general case documents. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search authoritative guiding, gazette, typical, database-selected, and reference cases, including judgment summaries. Authoritative cases are searched separately from general case documents. |
qcc_post_case_get_judicial_case_detailQCC — Case DetailsInspect
Retrieve the complete text of a general or authoritative judicial case by case ID or complete case number. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve the complete text of a general or authoritative judicial case by case ID or complete case number. |
qcc_post_case_get_judicial_case_searchQCC — General Case Keyword SearchInspect
Search general judicial cases by keywords, case number, parties, cause of action, court level, document type, and dates. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search general judicial cases by keywords, case number, parties, cause of action, court level, document type, and dates. |
qcc_post_case_get_judicial_citation_verifyQCC — Case Citation VerificationInspect
Identify case-number references in text or Markdown, verify their existence and sources, and add traceable links. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Identify case-number references in text or Markdown, verify their existence and sources, and add traceable links. |
qcc_post_company_get_actual_controllerQCC — Actual ControllerInspect
Retrieve the final actual-controller results already calculated by QCC's ownership penetration engine. The tool is distinct from direct shareholders and beneficial owners. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve the final actual-controller results already calculated by QCC's ownership penetration engine. The tool is distinct from direct shareholders and beneficial owners. |
qcc_post_company_get_annual_reportsQCC — Annual ReportsInspect
Retrieve published company annual reports, including company details, assets, contributions, investments, and other annual disclosures. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve published company annual reports, including company details, assets, contributions, investments, and other annual disclosures. |
qcc_post_company_get_beneficial_ownersQCC — Beneficial OwnersInspect
Retrieve natural-person beneficial owners and ultimate beneficial ownership percentages for the company. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve natural-person beneficial owners and ultimate beneficial ownership percentages for the company. |
qcc_post_company_get_branchesQCC — BranchesInspect
Retrieve the company's registered branches and their basic registration information. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve the company's registered branches and their basic registration information. |
qcc_post_company_get_change_recordsQCC — Registration ChangesInspect
Retrieve registration change records and the corresponding previous and updated values. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve registration change records and the corresponding previous and updated values. |
qcc_post_company_get_company_by_queryQCC — Company Entity IdentificationInspect
Identify a company using its name, abbreviation, brand, stock abbreviation, or other keywords. Returns an exact match or up to five candidate entities. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Identify a company using its name, abbreviation, brand, stock abbreviation, or other keywords. Returns an exact match or up to five candidate entities. |
qcc_post_company_get_company_profileQCC — Company ProfileInspect
Retrieve the company profile, QCC industry classification, company size, main products, and industry chain overview. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve the company profile, QCC industry classification, company size, main products, and industry chain overview. |
qcc_post_company_get_company_registration_infoQCC — Company Registration InformationInspect
Retrieve core company registration details, including legal representative, registered capital, incorporation date, registration status, and registered address. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve core company registration details, including legal representative, registered capital, incorporation date, registration status, and registered address. |
qcc_post_company_get_contact_infoQCC — Contact InformationInspect
Retrieve company phone numbers, usage labels, email addresses, websites, official-site indicators, and filing information. Confirmed invalid phone numbers may be excluded. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve company phone numbers, usage labels, email addresses, websites, official-site indicators, and filing information. Confirmed invalid phone numbers may be excluded. |
qcc_post_company_get_external_investmentsQCC — InvestmentsInspect
Retrieve companies invested in by the target company, with ownership and investment information. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve companies invested in by the target company, with ownership and investment information. |
qcc_post_company_get_financial_dataQCC — Financial DataInspect
Retrieve available company financial account items and amounts for financial analysis. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve available company financial account items and amounts for financial analysis. |
qcc_post_company_get_key_personnelQCC — Key PersonnelInspect
Retrieve key personnel and their registered positions in the company. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve key personnel and their registered positions in the company. |
qcc_post_company_get_listing_infoQCC — Listing InformationInspect
Retrieve listing information for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve listing information for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_company_get_tax_invoice_infoQCC — Tax and Invoicing InformationInspect
Retrieve invoicing details, including company tax number, registered address, contact phone, bank name, and account number. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve invoicing details, including company tax number, registered address, contact phone, bank name, and account number. |
qcc_post_company_verify_company_accuracyQCC — Company Identity VerificationInspect
Verify whether the supplied company or legal representative name matches the supplied Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Verify whether the supplied company or legal representative name matches the supplied Unified Social Credit Code. |
qcc_post_document_get_parse_resultQCC — Get Document Parsing ResultInspect
Retrieve the state and Markdown output of a task created by parse_document using its exact task_id. Result polling does not consume points. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve the state and Markdown output of a task created by parse_document using its exact task_id. Result polling does not consume points. |
qcc_post_document_parse_documentQCC — Submit Document ParsingInspect
Submit a directly accessible document URL for parsing into Markdown. Supports asynchronous processing and optional waiting; local files require the separate local bridge. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Submit a directly accessible document URL for parsing into Markdown. Supports asynchronous processing and optional waiting; local files require the separate local bridge. |
qcc_post_executive_get_executive_admin_penaltyQCC — Executive — Administrative PenaltiesInspect
Retrieve administrative penalties for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve administrative penalties for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_beneficial_ownerQCC — Executive — Ultimate Beneficiary RolesInspect
Retrieve ultimate beneficiary roles for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve ultimate beneficiary roles for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_case_filingQCC — Executive — Case FilingsInspect
Retrieve case filings for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve case filings for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_controlled_companiesQCC — Executive — Controlled CompaniesInspect
Retrieve controlled companies for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve controlled companies for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_court_noticeQCC — Executive — Court NoticesInspect
Retrieve court notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve court notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_dishonestQCC — Executive — Dishonest Judgment Debtor RecordsInspect
Retrieve dishonest judgment debtor records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve dishonest judgment debtor records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_equity_freezeQCC — Executive — Equity FreezesInspect
Retrieve equity freezes for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve equity freezes for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_equity_pledgeQCC — Executive — Equity Pledge RegistrationsInspect
Retrieve equity pledge registrations for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve equity pledge registrations for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_exit_restrictionQCC — Executive — Exit RestrictionsInspect
Retrieve exit restrictions for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve exit restrictions for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_hearing_noticeQCC — Executive — Hearing NoticesInspect
Retrieve hearing notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve hearing notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_high_consumption_banQCC — Executive — High Consumption RestrictionsInspect
Retrieve high consumption restrictions for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve high consumption restrictions for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_admin_penaltyQCC — Executive — Historical — Administrative PenaltiesInspect
Retrieve historical administrative penalties for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical administrative penalties for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_case_filingQCC — Executive — Historical — Case FilingsInspect
Retrieve historical case filings for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical case filings for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_court_noticeQCC — Executive — Historical — Court NoticesInspect
Retrieve historical court notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical court notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_dishonestQCC — Executive — Historical — Dishonest Judgment Debtor RecordsInspect
Retrieve historical dishonest judgment debtor records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical dishonest judgment debtor records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_equity_freezeQCC — Executive — Historical — Equity FreezesInspect
Retrieve historical equity freezes for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical equity freezes for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_equity_pledgeQCC — Executive — Historical — Equity Pledge RegistrationsInspect
Retrieve historical equity pledge registrations for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical equity pledge registrations for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_hearing_noticeQCC — Executive — Historical — Hearing NoticesInspect
Retrieve historical hearing notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical hearing notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_high_consumption_banQCC — Executive — Historical — High Consumption RestrictionsInspect
Retrieve historical high consumption restrictions for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical high consumption restrictions for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_investmentsQCC — Executive — Historical — InvestmentsInspect
Retrieve historical investments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical investments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_judgment_debtorQCC — Executive — Historical — Judgment Enforcement RecordsInspect
Retrieve historical judgment enforcement records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical judgment enforcement records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_judicial_docsQCC — Executive — Historical — Judgment DocumentsInspect
Retrieve historical judgment documents for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical judgment documents for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_legal_rep_rolesQCC — Executive — Historical — Legal Representative RolesInspect
Retrieve historical legal representative roles for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical legal representative roles for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_partnersQCC — Executive — Historical — Business PartnersInspect
Retrieve historical business partners for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical business partners for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_positionsQCC — Executive — Historical — External AppointmentsInspect
Retrieve historical external appointments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical external appointments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_pre_litigation_mediaQCC — Executive — Historical — Pre-Litigation MediationInspect
Retrieve historical pre-litigation mediation for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical pre-litigation mediation for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_service_noticeQCC — Executive — Historical — Service NoticesInspect
Retrieve historical service notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical service notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_historical_terminated_casesQCC — Executive — Historical — Terminated Enforcement CasesInspect
Retrieve historical terminated enforcement cases for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve historical terminated enforcement cases for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_investmentsQCC — Executive — InvestmentsInspect
Retrieve investments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve investments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_judgment_debtorQCC — Executive — Judgment Enforcement RecordsInspect
Retrieve judgment enforcement records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve judgment enforcement records for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_judicial_docsQCC — Executive — Judgment DocumentsInspect
Retrieve judgment documents for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve judgment documents for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_legal_rep_rolesQCC — Executive — Legal Representative RolesInspect
Retrieve legal representative roles for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve legal representative roles for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_positionsQCC — Executive — External AppointmentsInspect
Retrieve external appointments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve external appointments for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_pre_litigation_mediationQCC — Executive — Pre-Litigation MediationInspect
Retrieve pre-litigation mediation for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve pre-litigation mediation for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_property_reward_noticeQCC — Executive — Asset Recovery Reward NoticesInspect
Retrieve asset recovery reward notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve asset recovery reward notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_risk_scanQCC — Executive — Personal Risk ScanInspect
Retrieve personal risk scan for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve personal risk scan for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_service_noticeQCC — Executive — Service NoticesInspect
Retrieve service notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve service notices for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_stock_pledgeQCC — Executive — Share PledgesInspect
Retrieve share pledges for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve share pledges for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_tax_violationQCC — Executive — Tax ViolationsInspect
Retrieve tax violations for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve tax violations for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_terminated_casesQCC — Executive — Terminated Enforcement CasesInspect
Retrieve terminated enforcement cases for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve terminated enforcement cases for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_executive_get_executive_valuation_inquiryQCC — Executive — Valuation InquiriesInspect
Retrieve valuation inquiries for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve valuation inquiries for a named director, supervisor, or senior executive. Both the company identity and person name anchor the query. |
qcc_post_ipr_get_app_infoQCC — Mobile AppsInspect
Retrieve mobile apps for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve mobile apps for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_commercial_franchiseQCC — Commercial FranchisesInspect
Retrieve commercial franchises for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve commercial franchises for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_copyright_work_infoQCC — Work Copyright RegistrationsInspect
Retrieve work copyright registrations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve work copyright registrations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_douyin_accountQCC — Douyin AccountsInspect
Retrieve douyin accounts for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve douyin accounts for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_integrated_circuit_layoutQCC — Integrated Circuit Layout RegistrationsInspect
Retrieve integrated circuit layout registrations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve integrated circuit layout registrations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_international_patentQCC — International PatentsInspect
Retrieve international patents for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve international patents for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_internet_service_infoQCC — Internet Service FilingsInspect
Retrieve internet service filings for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve internet service filings for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_ipr_pledgeQCC — Intellectual Property PledgesInspect
Retrieve intellectual property pledges for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve intellectual property pledges for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_kuaishou_accountQCC — Kuaishou AccountsInspect
Retrieve kuaishou accounts for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve kuaishou accounts for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_mini_programQCC — Mini ProgramsInspect
Retrieve mini programs for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve mini programs for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_online_storeQCC — Online StoresInspect
Retrieve online stores for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve online stores for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_patent_infoQCC — PatentsInspect
Retrieve patents for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve patents for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_software_copyright_infoQCC — Software Copyright RegistrationsInspect
Retrieve software copyright registrations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve software copyright registrations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_standard_infoQCC — StandardsInspect
Retrieve standards for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve standards for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_trademark_documentQCC — Trademark Review DocumentsInspect
Retrieve trademark review documents for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve trademark review documents for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_trademark_infoQCC — TrademarksInspect
Retrieve trademarks for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve trademarks for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_wechat_official_accountQCC — WeChat Official AccountsInspect
Retrieve wechat official accounts for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve wechat official accounts for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_ipr_get_weibo_accountQCC — Weibo AccountsInspect
Retrieve weibo accounts for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve weibo accounts for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_administrative_licenseQCC — Administrative LicensesInspect
Retrieve administrative licenses for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve administrative licenses for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_advertising_reviewQCC — Advertising ApprovalsInspect
Retrieve advertising approvals for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve advertising approvals for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_asset_auctionQCC — Asset AuctionsInspect
Retrieve asset auctions for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve asset auctions for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_bidding_infoQCC — Company Tender and Award RecordsInspect
Retrieve company tender and award records for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve company tender and award records for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_bond_financing_infoQCC — Bond FinancingInspect
Retrieve bond financing for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve bond financing for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_company_announcementQCC — Company AnnouncementsInspect
Retrieve company announcements for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve company announcements for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_counterfeit_cosmeticsQCC — Counterfeit Cosmetics NoticesInspect
Retrieve counterfeit cosmetics notices for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve counterfeit cosmetics notices for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_credit_commitmentsQCC — Credit CommitmentsInspect
Retrieve credit commitments for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve credit commitments for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_credit_evaluationQCC — Credit AssessmentsInspect
Retrieve credit assessments for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve credit assessments for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_entry_deniedQCC — Import Entry RejectionsInspect
Retrieve import entry rejections for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve import entry rejections for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_financing_lease_infoQCC — Finance LeasesInspect
Retrieve finance leases for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve finance leases for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_financing_recordsQCC — Financing RoundsInspect
Retrieve financing rounds for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve financing rounds for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_food_safetyQCC — Food Safety InspectionsInspect
Retrieve food safety inspections for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve food safety inspections for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_game_approvalQCC — Game ApprovalsInspect
Retrieve game approvals for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve game approvals for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_government_announcementQCC — Government AnnouncementsInspect
Retrieve government announcements for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve government announcements for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_government_interviewQCC — Regulatory InterviewsInspect
Retrieve regulatory interviews for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve regulatory interviews for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_honor_infoQCC — HonorsInspect
Retrieve honors for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve honors for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_import_export_creditQCC — Import and Export CreditInspect
Retrieve import and export credit for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve import and export credit for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_investment_institutionQCC — Investment InstitutionsInspect
Retrieve investment institutions for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve investment institutions for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_land_grant_infoQCC — State-Owned Land AcquisitionsInspect
Retrieve state-owned land acquisitions for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve state-owned land acquisitions for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_land_transfer_infoQCC — Land TransfersInspect
Retrieve land transfers for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve land transfers for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_news_sentimentQCC — News and SentimentInspect
Retrieve news and sentiment for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve news and sentiment for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_private_fund_managerQCC — Private Fund ManagersInspect
Retrieve private fund managers for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve private fund managers for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_product_recallQCC — Product RecallsInspect
Retrieve product recalls for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve product recalls for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_product_spot_checkQCC — Product InspectionsInspect
Retrieve product inspections for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve product inspections for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_property_rights_transactionQCC — Property Rights TransactionsInspect
Retrieve property rights transactions for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve property rights transactions for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_qualificationsQCC — Qualification CertificatesInspect
Retrieve qualification certificates for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve qualification certificates for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_random_checkQCC — Randomized InspectionsInspect
Retrieve randomized inspections for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve randomized inspections for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_ranking_list_infoQCC — Ranking AppearancesInspect
Retrieve ranking appearances for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve ranking appearances for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_recruitment_infoQCC — RecruitmentInspect
Retrieve recruitment for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve recruitment for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_software_violationQCC — Software Compliance ViolationsInspect
Retrieve software compliance violations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve software compliance violations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_spot_check_infoQCC — Spot Checks and InspectionsInspect
Retrieve spot checks and inspections for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve spot checks and inspections for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_taxpayer_qualificationQCC — Taxpayer QualificationsInspect
Retrieve taxpayer qualifications for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve taxpayer qualifications for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_tech_achievementQCC — Registered Technology AchievementsInspect
Retrieve registered technology achievements for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve registered technology achievements for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_operation_get_telecom_licenseQCC — Telecommunications LicensesInspect
Retrieve telecommunications licenses for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve telecommunications licenses for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_regulation_get_legal_article_detailQCC — Article DetailsInspect
Retrieve the exact text of a statutory article by article ID or regulation name plus article number. Supports normalized common names and point-in-time versions. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve the exact text of a statutory article by article ID or regulation name plus article number. Supports normalized common names and point-in-time versions. |
qcc_post_regulation_get_legal_article_searchQCC — Article Keyword SearchInspect
Search article text by keywords and optional parent regulation and validity filters, returning the regulation, article number, and article text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search article text by keywords and optional parent regulation and validity filters, returning the regulation, article number, and article text. |
qcc_post_regulation_get_legal_article_semantic_searchQCC — Article Semantic SearchInspect
Use a natural-language legal question or case description to retrieve relevant statutory articles ranked by semantic relevance. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Use a natural-language legal question or case description to retrieve relevant statutory articles ranked by semantic relevance. |
qcc_post_regulation_get_legal_citation_verifyQCC — Statute Citation VerificationInspect
Identify statute and article references within text or Markdown, verify them against the legal database, and add traceable source links. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Identify statute and article references within text or Markdown, verify them against the legal database, and add traceable source links. |
qcc_post_regulation_get_legal_regulation_detailQCC — Regulation DetailsInspect
Retrieve a regulation's full structure and text by ID or normalized name. Long regulations may initially return a table of contents; point-in-time versions are supported. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a regulation's full structure and text by ID or normalized name. Long regulations may initially return a table of contents; point-in-time versions are supported. |
qcc_post_regulation_get_legal_regulation_searchQCC — Regulation Keyword SearchInspect
Search regulation metadata by name, issuing authority, legal authority level, validity, territory, and dates before retrieving full text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search regulation metadata by name, issuing authority, legal authority level, validity, territory, and dates before retrieving full text. |
qcc_post_risk_get_administrative_penaltyQCC — Administrative PenaltiesInspect
Retrieve administrative penalties for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve administrative penalties for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_bankruptcy_reorganizationQCC — Bankruptcy and ReorganizationInspect
Retrieve bankruptcy and reorganization for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve bankruptcy and reorganization for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_business_exceptionQCC — Abnormal OperationsInspect
Retrieve abnormal operations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve abnormal operations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_cancellation_record_infoQCC — Deregistration FilingsInspect
Retrieve deregistration filings for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve deregistration filings for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_case_filing_infoQCC — Case FilingsInspect
Retrieve case filings for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve case filings for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_chattel_mortgage_infoQCC — Chattel MortgagesInspect
Retrieve chattel mortgages for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve chattel mortgages for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_company_risk_scanQCC — Company Risk ScanInspect
Scan risk dimensions of the company itself and return record counts to identify which dimensions need detailed follow-up. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Scan risk dimensions of the company itself and return record counts to identify which dimensions need detailed follow-up. |
qcc_post_risk_get_court_noticeQCC — Court NoticesInspect
Retrieve court notices for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve court notices for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_default_infoQCC — Default EventsInspect
Retrieve default events for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve default events for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_disciplinary_listQCC — Disciplinary ListsInspect
Retrieve disciplinary lists for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve disciplinary lists for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_dishonest_infoQCC — Dishonest Judgment Debtor RecordsInspect
Retrieve dishonest judgment debtor records for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve dishonest judgment debtor records for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_environmental_penaltyQCC — Environmental PenaltiesInspect
Retrieve environmental penalties for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve environmental penalties for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_equity_freezeQCC — Equity FreezesInspect
Retrieve equity freezes for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve equity freezes for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_equity_pledge_infoQCC — Equity Pledge RegistrationsInspect
Retrieve equity pledge registrations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve equity pledge registrations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_exit_restrictionQCC — Exit RestrictionsInspect
Retrieve exit restrictions for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve exit restrictions for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_guarantee_infoQCC — GuaranteesInspect
Retrieve guarantees for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve guarantees for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_hearing_noticeQCC — Hearing NoticesInspect
Retrieve hearing notices for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve hearing notices for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_high_consumption_restrictionQCC — High Consumption RestrictionsInspect
Retrieve high consumption restrictions for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve high consumption restrictions for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_judgment_debtor_infoQCC — Judgment Enforcement RecordsInspect
Retrieve judgment enforcement records for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve judgment enforcement records for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_judicial_auctionQCC — Judicial AuctionsInspect
Retrieve judicial auctions for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve judicial auctions for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_judicial_document_detailQCC — Judgment Document DetailsInspect
Retrieve the selected judgment document for the same company used in the document list query. Supports core judgment, claims and defenses, procedural history, or the complete document. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve the selected judgment document for the same company used in the document list query. Supports core judgment, claims and defenses, procedural history, or the complete document. |
qcc_post_risk_get_judicial_documentsQCC — Judgment DocumentsInspect
Retrieve judgment documents for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve judgment documents for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_land_mortgage_infoQCC — Land MortgagesInspect
Retrieve land mortgages for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve land mortgages for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_liquidation_infoQCC — Liquidation RecordsInspect
Retrieve liquidation records for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve liquidation records for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_pre_litigation_mediationQCC — Pre-Litigation MediationInspect
Retrieve pre-litigation mediation for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve pre-litigation mediation for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_property_asset_announcementQCC — Asset Recovery Reward NoticesInspect
Retrieve asset recovery reward notices for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve asset recovery reward notices for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_public_exhortationQCC — Public SummonsInspect
Retrieve public summons for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve public summons for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_serious_violationQCC — Serious ViolationsInspect
Retrieve serious violations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve serious violations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_service_announcementQCC — Labor Arbitration NoticesInspect
Retrieve labor arbitration notices for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve labor arbitration notices for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_service_noticeQCC — Service NoticesInspect
Retrieve service notices for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve service notices for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_simple_cancellation_infoQCC — Simplified DeregistrationInspect
Retrieve simplified deregistration for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve simplified deregistration for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_stock_pledge_infoQCC — Share PledgesInspect
Retrieve share pledges for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve share pledges for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_tax_abnormalQCC — Abnormal Taxpayer RecordsInspect
Retrieve abnormal taxpayer records for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve abnormal taxpayer records for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_tax_arrears_noticeQCC — Tax Arrears NoticesInspect
Retrieve tax arrears notices for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve tax arrears notices for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_tax_violationQCC — Tax ViolationsInspect
Retrieve tax violations for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve tax violations for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_terminated_casesQCC — Terminated Enforcement CasesInspect
Retrieve terminated enforcement cases for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve terminated enforcement cases for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_risk_get_valuation_inquiryQCC — Valuation InquiriesInspect
Retrieve valuation inquiries for a company identified by its full registered name or Unified Social Credit Code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve valuation inquiries for a company identified by its full registered name or Unified Social Credit Code. |
qcc_post_tender_get_proposed_project_detailQCC — Proposed Project DetailsInspect
Retrieve a proposed project using an ID returned by search_proposed_projects, including investment, schedule, participants, approval records, and project text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a proposed project using an ID returned by search_proposed_projects, including investment, schedule, participants, approval records, and project text. |
qcc_post_tender_get_tender_detailQCC — Tender Notice DetailsInspect
Retrieve a complete tender or award notice using an ID returned by search_tenders, including amounts, dates, participants, contacts, and notice text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a complete tender or award notice using an ID returned by search_tenders, including amounts, dates, participants, contacts, and notice text. |
qcc_post_tender_search_companiesQCC — Tender Company SearchInspect
Search companies and their tender participation profiles by company keywords, notice roles, registration region, industry codes, and registration statuses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search companies and their tender participation profiles by company keywords, notice roles, registration region, industry codes, and registration statuses. |
qcc_post_tender_search_company_tendersQCC — Company Tender SearchInspect
Retrieve a previously identified company's tender notices using its returned company ID, with role, keyword, notice status, date, and region filters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Retrieve a previously identified company's tender notices using its returned company ID, with role, keyword, notice status, date, and region filters. |
qcc_post_tender_search_proposed_projectsQCC — Proposed Project SearchInspect
Search proposed projects by keywords, region, project stage, approval progress, dates, and investment range. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search proposed projects by keywords, region, project stage, approval progress, dates, and investment range. |
qcc_post_tender_search_tendersQCC — Tender and Award SearchInspect
Search tender and award notices by product or project keywords, region, industry, procurement method, publication dates, notice status, budget, and awarded amount. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search tender and award notices by product or project keywords, region, industry, procurement method, publication dates, notice status, budget, and awarded amount. |
rugcheck_get_v1_domainsRugCheck — Get registered domainsInspect
Returns all registered .token domains Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for results | |
| limit | No | Limit number of results | |
| verified | No | Filter to only domains with verification set |
rugcheck_get_v1_domains_lookup_idRugCheck — Lookup domain addressInspect
Returns the related domain address Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Domain name 使用完整 name.tld,例如 bonfida.sol;系统地址 11111111111111111111111111111111 不应当作成功解析的 token mint。 |
rugcheck_get_v1_leaderboardRugCheck — Get leaderboardInspect
Get user leaderboard rankings Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number | |
| limit | No | Results per page |
rugcheck_get_v1_searchRugCheck — Search tokensInspect
Full-text search over token name, symbol, and mint address, ranked so Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search query (name, symbol, or mint address) | |
| page | No | Page number for results (default 0) | |
| limit | No | Max results (default 20, capped at 50) | |
| maxScore | No | Filter out tokens with a risk score above this value (default 0, unfiltered) |
rugcheck_get_v1_stats_analyticsRugCheck — Analytics metricsInspect
Returns token launch counts, rug counts, time-to-rug by platform, and rugged market cap totals Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| window | No | Time window for stats: 24h, 1d, 7d, 30d (default: 7d) |
rugcheck_get_v1_stats_new_tokensRugCheck — Recently detected tokensInspect
Recently detected tokens Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
rugcheck_get_v1_stats_recentRugCheck — Most viewed tokensInspect
Returns the most viewed token mints, ranked by approximate unique views for the selected window Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Results per page | |
| window | No | Time window: 1m, 5m, 30m, 1h, 6h, 24h, 1w |
rugcheck_get_v1_stats_rugs_tickerRugCheck — Recent rugs for header tickerInspect
Returns the most recent rug events in a lightweight format for the website header ticker Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of events (max 50, default 10) |
rugcheck_get_v1_stats_rugs_top_liquidityRugCheck — Biggest rugs by liquidity pulledInspect
Returns the top N rugs ranked by actual USD liquidity pulled from the pool, rather than peak FDV market cap Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of events (max 25, default 15) |
rugcheck_get_v1_stats_trendingRugCheck — Most voted for tokens in past 24 hoursInspect
Only users who have connected their wallet are able to vote Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
rugcheck_get_v1_stats_verifiedRugCheck — Recently verified tokensInspect
Recently verified tokens Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
rugcheck_get_v1_tokens_id_insiders_graphRugCheck — Get token insider graphInspect
Generate an insider graph for given token mint Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Token mint address |
rugcheck_get_v1_tokens_id_insiders_networksRugCheck — Get token insider networksInspect
Generate an insider networks for given token mint Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Token mint address |
rugcheck_get_v1_tokens_id_reportRugCheck — Get full token reportInspect
Generate a detailed report for given token mint Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Token mint address |
rugcheck_get_v1_tokens_id_report_summaryRugCheck — Get token report summaryInspect
Generate a report summary for given token mint Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Token mint address | |
| cacheOnly | No | Only return cached reports |
rugcheck_get_v1_tokens_id_votesRugCheck — Get token votesInspect
Returns the voting statistics for a token mint Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Token mint address |
scrapecreators_get_v1_account_credit_balanceScrape Creators — Get credit balanceInspect
Returns the number of API credits remaining on your Scrape Creators account. The response contains a single creditCount field with your current balance. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
scrapecreators_get_v1_account_get_api_usageScrape Creators — Get request historyInspect
Returns a paginated list of your API requests, including the endpoint called, status code, credits used, and timestamp. Useful for debugging and monitoring your API usage. Supports filtering by endpoint name and status code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (max 100) | |
| endpoint | No | Filter by endpoint name (partial match) | |
| statusCode | No | Filter by HTTP status code |
scrapecreators_get_v1_account_get_daily_usage_countScrape Creators — Get daily usageInspect
Returns aggregated daily usage statistics for the last 30 days, including total credits consumed and number of requests per day. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
scrapecreators_get_v1_account_get_most_used_routesScrape Creators — Get most used routesInspect
Returns your top 20 most called API endpoints ranked by call count, along with total credits consumed per endpoint. Defaults to the last 24 hours. Supports custom time ranges up to 1 year. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_time | No | End of time range (ISO 8601 format) | |
| start_time | No | Start of time range (ISO 8601 format) |
scrapecreators_get_v1_amazon_shopAmazon Shop — Amazon Shop pageInspect
Scrapes a creator's Amazon Shop page by URL, returning their storefront profile and product collections. The initial request also returns videos already embedded on the storefront page without requiring a pageToken. Videos include an id, title, thumbnail, and attached ASINs. Pass each returned pageToken back unchanged with the same shop URL. A paginated page can contain lists, videos, or both. Tokens are opaque: known values can begin with amzn1.ideas, amzn1.vse.video, or amzn1.shoppablemedia, but clients should not infer the response type from the prefix. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL to Amazon Shop page | |
| pageToken | No | Opaque page token returned by a previous response for the same shop URL. Pass it back unchanged and do not infer the response type from its prefix. A page can contain lists, videos, or both. |
scrapecreators_get_v1_apple_music_albumApple Music — AlbumInspect
Retrieves public Apple Music album details, including title, artist, artwork, release info, tracks, and more by the artist. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Apple Music album id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Apple Music album URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
scrapecreators_get_v1_apple_music_artistApple Music — ArtistInspect
Retrieves public Apple Music artist details, including artwork, editorial notes, top songs, albums, music videos, playlists, and related sections. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Apple Music artist id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Apple Music artist URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
scrapecreators_get_v1_apple_music_searchApple Music — SearchInspect
Searches Apple Music and returns public result sections for artists, albums, songs, playlists, stations, and music videos. Use type=song, album, artist, playlist, or all. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Result type to return. Use all, song, album, artist, playlist, station, music_video, or radio_episode. | |
| query | Yes | Search query |
scrapecreators_get_v1_apple_music_trackApple Music — TrackInspect
Retrieves public Apple Music song details by id or URL. Album track URLs with an i= song id are supported. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Apple Music song id. Some songs have standalone song URLs; for album tracks, use the url parameter. | |
| url | No | Apple Music song URL or album track URL. |
scrapecreators_get_v1_bluesky_postBluesky — PostInspect
Fetches a single Bluesky post by URL, returning the post's record text, author info, embed content, replyCount, repostCount, likeCount, and quoteCount. Also includes a replies array with threaded reply posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Bluesky post URL |
scrapecreators_get_v1_bluesky_profileBluesky — ProfileInspect
Retrieves a Bluesky user's public profile including handle, displayName, avatar, description, followersCount, followsCount, postsCount, createdAt, and verification status. The associated field shows counts for lists, feed generators, and starter packs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Bluesky handle |
scrapecreators_get_v1_bluesky_user_postsBluesky — PostsInspect
Fetches a paginated feed of posts from a Bluesky user, returning each post's uri, record text, author info, embed content, replyCount, repostCount, likeCount, quoteCount, and indexedAt. Supports pagination via cursor. Use user_id (the 'did') instead of handle for faster response times. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | No | Bluesky handle | |
| user_id | No | Bluesky 'did'. (For some reason Bluesky calls their user ids, 'did' for whatever reason) |
scrapecreators_get_v1_cosmos_clusterCosmos — CollectionInspect
Get a public Cosmos collection with its owner, description, cover, counts, and public subcollections. Uses public Cosmos data. Private or login-restricted content is not available. Costs 1 credit per successful request, including native empty results. Scraper failures are not charged. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public Cosmos collection URL. |
scrapecreators_get_v1_cosmos_cluster_postsCosmos — Collection PostsInspect
Get public posts saved to a Cosmos collection. Supports cursor pagination. Uses public Cosmos data. Private or login-restricted content is not available. Costs 1 credit per successful request, including native empty results. Scraper failures are not charged. Sending cursor=null returns end_of_pagination: true and costs zero credits. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public Cosmos collection URL. | |
| cursor | No | Pass the previous response cursor unchanged. Stop when it is null; sending the literal string "null" returns an empty terminal page without fetching or charging. |
scrapecreators_get_v1_cosmos_postCosmos — PostInspect
Get a public Cosmos post with media URLs, captions, source links, and save count. Uses public Cosmos data. Private or login-restricted content is not available. Costs 1 credit per successful request, including native empty results. Scraper failures are not charged. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public Cosmos post URL. |
scrapecreators_get_v1_cosmos_profileCosmos — ProfileInspect
Get a public Cosmos profile with bio, links, and follower counts. Public data only. One credit per successful request, including successful empty results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Cosmos username without a profile URL. |
scrapecreators_get_v1_cosmos_searchCosmos — SearchInspect
Search public Cosmos posts by keyword. Cosmos may return related posts even when there is no exact keyword match. Public data only. One credit per successful request, including successful empty results. Keep the cursor unchanged and stop when has_more is false. result_count is Cosmos’s search retrieval-window count, not the total number of matching posts. Sending cursor=null returns end_of_pagination: true and costs zero credits. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search text. | |
| cursor | No | Pass the previous response cursor unchanged. Stop when it is null; sending the literal string "null" returns an empty terminal page without fetching or charging. |
scrapecreators_get_v1_cosmos_user_clustersCosmos — User CollectionsInspect
Get the public collections owned by a Cosmos user. Public data only. One credit per successful request, including successful empty results. Keep the cursor unchanged and stop when has_more is false. Sending cursor=null returns end_of_pagination: true and costs zero credits. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pass the previous response cursor unchanged. Stop when it is null; sending the literal string "null" returns an empty terminal page without fetching or charging. | |
| handle | Yes | Cosmos username without a profile URL. |
scrapecreators_get_v1_cosmos_user_postsCosmos — User PostsInspect
Get the public posts saved to a Cosmos user profile. Public data only. One credit per successful request, including successful empty results. Keep the cursor unchanged and stop when has_more is false. Sending cursor=null returns end_of_pagination: true and costs zero credits. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pass the previous response cursor unchanged. Stop when it is null; sending the literal string "null" returns an empty terminal page without fetching or charging. | |
| handle | Yes | Cosmos username without a profile URL. |
scrapecreators_get_v1_detect_age_genderCreator Tools — Get Age and GenderInspect
Uses AI to analyze a creator's profile photo and estimate their age and gender. Returns ageRange with low and high bounds, gender, and a confidence score for the gender prediction. The profile photo must contain a clear, visible face for accurate results. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL to users social profile |
scrapecreators_get_v1_facebook_adlibrary_adFacebook Ad DetailsInspect
Retrieves detailed information about a specific Facebook ad by its ID or URL. Returns adArchiveID, pageName, isActive, startDate, endDate, and a snapshot containing body, images, videos, display_format, link_url, and cta_text. Regulated ads may also include source-dependent aaa_info using the structure shown below. Political and social issue delivery data is normalized to location_audience and age_country_gender_reach_breakdown. Political location_audience rows include reach, and political delivery values are fractional shares, so 0.08 means 8%. Regional transparency data may use absolute reac Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Facebook Ad Id | |
| url | No | Facebook Ad URL | |
| trim | No | Set to true for a trimmed down version of the response | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit; default short AI is included; allow_long_transcription=true adds 10 credits per started minute to the existing base cost). [See the Caching page for details.](https://docs.scrapecreators.com/caching) | |
| get_transcript | No | Transcription is opt-in via get_transcript=true. Default short AI (up to 120 seconds, inclusive) is included in the existing base endpoint price, with no extra AI fee. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. On detail routes, successful paid-mode AI costs are in addition to the existing base endpoint cost; media-download pricing is unchanged. Returned native captions leave the base endpoint price unchanged. Empty AI results and errors incur no AI fee; the base scrape fee still applies when the detail scrape succeeds. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. | |
| allow_long_transcription | No | Paid opt-in, enabled only by the literal query value 'true' (allow_long_transcription=true). Defaults to false when omitted; other values do not enable paid mode. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get_transcript=true or use_ai_as_fallback=true where required by the endpoint. Returned native captions still cost 1 credit on dedicated transcript routes, even for long videos with this flag; on detail routes they leave the base price unchanged. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. |
scrapecreators_get_v1_facebook_adlibrary_company_adsFacebook Ad Library — Company AdsInspect
Fetches all ads currently running for a specific company from the Meta Ad Library. Each ad includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body, images, videos, and display_format. Supports filtering by country, media_type, date range, and language with cursor-based pagination. Both GET and POST are supported. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| cursor | No | Cursor to paginate through results | |
| pageId | No | The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName | |
| status | No | Status of the ad. Defaults to ACTIVE. | |
| country | No | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. | |
| sort_by | No | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. | |
| end_date | No | End date to search for. Format: YYYY-MM-DD | |
| language | No | Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc | |
| media_type | No | Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme. | |
| start_date | No | Start date to search for. Format: YYYY-MM-DD | |
| companyName | No | The name of the company. Can either use this or pageId |
scrapecreators_get_v1_facebook_adlibrary_search_adsFacebook Ad Library — SearchInspect
Searches the Meta Ad Library by keyword and returns matching ads. Supports filtering by language with a 2-letter code such as EN or ES. Each result includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body text, images, videos, and cta_text. Both GET and POST are supported. Use GET for normal requests. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| query | Yes | Keyword to search for | |
| cursor | No | Cursor to paginate through results | |
| status | No | Status of the ad. Defaults to ACTIVE. | |
| ad_type | No | Search for all ads or only political and issue ads | |
| country | No | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. | |
| sort_by | No | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. | |
| end_date | No | Impressions end date. Needs to be in YYYY-MM-DD format. | |
| language | No | Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR. | |
| media_type | No | Media type of the ad. Defaults to ALL. Meme just means the ad has text and an image. No clue why they call it meme. | |
| start_date | No | Impressions start date. Needs to be in YYYY-MM-DD format. | |
| search_type | No | If you want to search by exact phrase or not |
scrapecreators_get_v1_facebook_adlibrary_search_companiesFacebook Ad Library — Search for CompaniesInspect
Searches for companies by name in the Meta Ad Library and returns their page IDs for use with other ad library endpoints. Each result includes page_id, name, category, likes, verification status, and Instagram details like ig_username and ig_followers. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Keyword to search for |
scrapecreators_get_v1_facebook_event_detailsFacebook Events — Event DetailsInspect
Get a specific event by its URL or id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The ID of the event | |
| url | No | The URL of the event |
scrapecreators_get_v1_facebook_eventsFacebook Events — EventsInspect
Get the events of a city. Check out this link for an example of where we are getting the data from. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the city's Facebook Events page | |
| time | No | The time frame to search for. Defaults to all time | |
| cursor | No | The cursor to paginate to the next page |
scrapecreators_get_v1_facebook_events_searchFacebook Events — Search EventsInspect
Search for events by name. You can take a look at the page from Facebook we are getting the data from here Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The query to search for | |
| cursor | No | The cursor to paginate to the next page |
scrapecreators_get_v1_facebook_groupFacebook — Facebook Group InfoInspect
Fetches the public information shown on a Facebook group's About page, including its description, privacy and visibility, member and activity counts, categories, administrators and moderators when Facebook exposes them, group history, and rules. Provide either url or group_id. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The Facebook group URL. Group sub-page URLs such as /about work too. | |
| group_id | No | The numeric Facebook group ID. Provide this instead of url if you already have it. |
scrapecreators_get_v1_facebook_group_postsFacebook — Facebook Group PostsInspect
Fetches posts from a public Facebook group, limited to 3 posts per page due to API limitations. Each post includes id, text, url, reactionCount, commentCount, publishTime, videoDetails, and topComments. Results are chronological by default. Supports TOP_POSTS, RECENT_ACTIVITY, CHRONOLOGICAL, and CHRONOLOGICAL_LISTINGS with cursor-based pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The URL of the group | |
| cursor | No | The cursor to paginate to the next page | |
| sort_by | No | How to sort the posts. Defaults to CHRONOLOGICAL. | |
| group_id | No | The ID of the group |
scrapecreators_get_v1_facebook_marketplace_itemFacebook Marketplace — Marketplace ItemInspect
Fetches details for a Facebook Marketplace item by item id or Marketplace item URL, including title, description, price, location, condition, photos, seller, and availability flags. Rental listings can include listing_date_text and availability_text from Facebook's Marketplace GraphQL response, for example 'Listed over a week ago' and 'Available now'. creation_time can still be null when Facebook does not expose an exact timestamp. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Facebook Marketplace item id | |
| url | No | Facebook Marketplace item URL |
scrapecreators_get_v1_facebook_marketplace_location_searchFacebook Marketplace — Marketplace Location SearchInspect
Searches Facebook Marketplace locations/cities and returns coordinates you can use with the Marketplace Search endpoint. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Location search query |
scrapecreators_get_v1_facebook_marketplace_searchFacebook Marketplace — Marketplace SearchInspect
Searches Facebook Marketplace listings by keyword and lat/lng. Each page contains up to 24 listings. Each listing includes creation_time as an ISO 8601 UTC timestamp when Facebook exposes an exact listing timestamp, plus listing_date_text when available; either field can be null. Pass category_id to restrict results to the numeric Facebook Marketplace category ID returned on listing results. Supports pagination with the returned cursor. Pass the cursor value back as-is. The sort and date filters use the same values as Facebook's Marketplace UI. creation_time_descend usually orders the first pa Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| lat | Yes | Latitude for the search location | |
| lng | Yes | Longitude for the search location | |
| query | Yes | Search keyword | |
| cursor | No | Opaque pagination cursor returned from the previous response. Pass it back as-is. | |
| sort_by | No | Facebook Marketplace sort option. creation_time_descend usually orders the first pages newest first, but Facebook can insert newer listings on later cursor pages. | |
| condition | No | Condition filter | |
| max_price | No | Maximum listing price | |
| min_price | No | Minimum listing price | |
| radius_km | No | Search radius in kilometers | |
| category_id | No | Numeric Facebook Marketplace category ID. Listing results include this value as category_id. | |
| date_listed | No | Facebook Marketplace date filter. Uses the same calendar-day buckets as the UI, so last_24_hours can include listings from the prior calendar day. | |
| availability | No | Availability filter | |
| delivery_method | No | Delivery filter |
scrapecreators_get_v1_facebook_postFacebook Post / Reel DetailsInspect
Retrieves a single public Facebook post or reel by URL. Use one request per reel, passing its returned /reel/ URL from /v1/facebook/profile/reels, to retrieve available like_count, reaction_counts, comment_count, share_count, and a more precise view_count when Facebook exposes it. This endpoint accepts a single URL, not a batch; exact views are not guaranteed. Returns post_id, like_count, comment_count, share_count, view_count, description, creation_time, and author details, including the author handle when Facebook exposes a vanity profile URL. For some reels, Facebook does not expose the sam Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the post to get | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit; default short AI is included; allow_long_transcription=true adds 10 credits per started minute to the existing base cost). [See the Caching page for details.](https://docs.scrapecreators.com/caching) | |
| get_transcript | No | Transcription is opt-in via get_transcript=true. Default short AI (up to 120 seconds, inclusive) is included in the existing base endpoint price, with no extra AI fee. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. On detail routes, successful paid-mode AI costs are in addition to the existing base endpoint cost; media-download pricing is unchanged. Returned native captions leave the base endpoint price unchanged. Empty AI results and errors incur no AI fee; the base scrape fee still applies when the detail scrape succeeds. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. | |
| allow_long_transcription | No | Paid opt-in, enabled only by the literal query value 'true' (allow_long_transcription=true). Defaults to false when omitted; other values do not enable paid mode. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get_transcript=true or use_ai_as_fallback=true where required by the endpoint. Returned native captions still cost 1 credit on dedicated transcript routes, even for long videos with this flag; on detail routes they leave the base price unchanged. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. |
scrapecreators_get_v1_facebook_post_comment_repliesFacebook — Comment RepliesInspect
Get the replies to a comment. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | The cursor to paginate to the next page | |
| feedback_id | Yes | The *feedback_id* of the comment. Be careful, this is not the comment id. You can get the feedback_id from the /v1/facebook/post/comments endpoint. | |
| expansion_token | Yes | The expansion_token of the comment. You can get the expansion_token from the /v1/facebook/post/comments endpoint. |
scrapecreators_get_v1_facebook_post_commentsFacebook — CommentsInspect
Fetches comments from a Facebook post or reel with cursor-based pagination. Each comment includes id, text, created_at, reply_count, reaction_count, and author details with name and profile_picture. Passing a feedback_id instead of a url significantly speeds up the request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Facebook post URL (or reel URL) | |
| cursor | No | Cursor to get more comments. Get 'cursor' from previous response. | |
| feedback_id | No | Using feedback_id (instead of url) will *really* speed up the request. You can get the feedback_id when you make a request to /v1/facebook/post. |
scrapecreators_get_v1_facebook_profileFacebook — ProfileInspect
Retrieves public Facebook page details including category, address, email, phone, website, services, priceRange, rating, likeCount, talkingAboutCount, and followerCount. talkingAboutCount is nullable and only returned when Facebook exposes it publicly. Also returns adLibrary status with the page's ad activity and pageId. Optionally includes businessHours when get_business_hours is set to true. Contact fields come from the submitted public profile. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. If Facebook shows an Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Facebook profile URL | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) | |
| get_business_hours | No | Get the business's hours | |
| include_gated_profile | No | When true, returns limited public fields for gated or age-restricted profiles. Ignored for normal public profiles — those still return the full response. |
scrapecreators_get_v1_facebook_profile_eventsFacebook — Profile EventsInspect
Get the events of a public Facebook page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the public Facebook page | |
| cursor | No | The cursor to paginate to get more events |
scrapecreators_get_v1_facebook_profile_photosFacebook — Profile PhotosInspect
Fetches photos from a public Facebook page with pagination support. Each photo includes photo_id, accessibility_caption, viewer_image with uri, height, and width, plus a thumbnail and direct url. Pagination requires passing both next_page_id and cursor from the previous response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Facebook page URL | |
| cursor | No | To paginate through to the next page | |
| next_page_id | No | To paginate through to the next page |
scrapecreators_get_v1_facebook_profile_postsFacebook — Profile PostsInspect
Returns publicly visible Facebook profile posts, limited to 3 posts per page due to API limitations. Each post includes id, text, url, reactionCount, commentCount, publishTime, videoDetails with sdUrl, hdUrl, and thumbnailUrl, plus topComments. Accepts either a url or pageId parameter, where pageId is faster. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Facebook profile URL | |
| cursor | No | To paginate through the posts | |
| pageId | No | Facebook profile page id |
scrapecreators_get_v1_facebook_profile_reelsFacebook — Profile ReelsInspect
Fetches up to 10 reels per request from a public Facebook page. Each reel includes id, post_id, url, view_count, description, creation_time, video_url, thumbnail, play_time_in_ms, and music details. view_count comes from Facebook's public Reels badge (play_count_reduced), converted to a number; abbreviated values such as 27K become 27000, not an exact count. This list does not include like_count, reaction_counts, comment_count, share_count, or an is_pinned flag. Do not infer pinning from the order of returned reels. For available engagement metrics and a more precise view_count when Facebook e Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Facebook page URL | |
| cursor | No | To paginate through to the next page | |
| next_page_id | No | To paginate through to the next page |
scrapecreators_get_v1_facebook_search_videosFacebook — Search VideosInspect
Searches Facebook's native public video search without a logged-in account and returns matching videos and Reels. This is not Google-indexed discovery or general Facebook text/photo-post search. Results follow Facebook's ranking and public availability, so coverage and ordering are not exhaustive or guaranteed. Requests can take several seconds; use a client timeout of at least 30 seconds. Temporary Facebook restrictions or upstream timeouts can return an uncharged error. Pass the returned cursor with the same query for the next page, and stop when cursor is null or has_more is false. Each suc Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The keyword or phrase to search for | |
| cursor | No | The opaque cursor returned by the previous response. Keep the query unchanged when paginating. Stop when cursor is null or has_more is false. |
scrapecreators_get_v1_find_creator_emailsCreator Email FinderInspect
Creator Email Finder Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Creator handle without a profile URL. A leading @ is optional. | |
| platform | Yes | Source social platform | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit with no emails; 10 credits with any email (live lookups)). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_find_social_profilesCreator Tools — Find Social ProfilesInspect
Creator Tools — Find Social Profiles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Creator handle without a profile URL. A leading @ is optional. | |
| platform | Yes | Source social platform | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (10 credits). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_github_repositoryGitHub — RepositoryInspect
Retrieves public metadata for one GitHub repository, including owner, description, language, stars, forks, topics, license, visibility, default branch, open issues, and timestamps. Pass a full GitHub repository url. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | GitHub repository URL |
scrapecreators_get_v1_github_trending_developersGitHub — Trending DevelopersInspect
Scrapes GitHub's public Trending developers page. Returns ranked developers with username, name, public profile URL, avatar, and the popular repository GitHub shows for that developer when available. Use language for paths like javascript or python and since for daily/weekly/monthly. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| since | No | Trending range: daily, weekly, or monthly. Defaults to daily. | |
| language | No | Optional trending coding language, e.g. javascript, python, or go. |
scrapecreators_get_v1_github_trending_repositoriesGitHub — Trending RepositoriesInspect
Scrapes GitHub's public Trending repositories page. Returns ranked repositories with public URLs, descriptions, language, star/fork counts, stars for the selected range, and built-by users when GitHub shows them. Use language for paths like JavaScript or Python, since for daily/weekly/monthly, and spoken_language_code for GitHub's spoken language filter. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| since | No | Trending range: daily, weekly, or monthly. Defaults to daily. | |
| language | No | Optional coding language, e.g. javascript, python, or go. | |
| spoken_language_code | No | Optional spoken language code filter, e.g. en. |
scrapecreators_get_v1_github_userGitHub — UserInspect
Retrieves public GitHub user details including name, bio, avatar, company, location, blog, follower counts, public repo counts, and account timestamps. Pass username, handle, or a full GitHub user url. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | GitHub user URL, e.g. https://github.com/torvalds. | |
| handle | No | GitHub username/handle of the user you want the details for |
scrapecreators_get_v1_github_user_activityGitHub — ActivityInspect
Retrieves GitHub profile contribution activity for a user from the public profile activity timeline. Defaults to the current year when year is not provided. Results come back one month at a time in the activity array. Pass cursor from the previous response to page backward through the year. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | GitHub user URL, e.g. https://github.com/kentcdodds. | |
| year | No | When provided, returns profile contribution activity for that year. Defaults to the current year. | |
| cursor | No | Cursor from the previous response. Pages backward by month through the selected year. | |
| handle | No | GitHub handle |
scrapecreators_get_v1_github_user_contributionsGitHub — ContributionsInspect
Retrieves the public GitHub contribution graph for a user and year, including total contributions and daily contribution counts/intensity. Pass github handle, or a full GitHub profile url. Defaults to the current year when year is not provided. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | GitHub profile URL | |
| year | No | Contribution graph year. Defaults to the current year. | |
| handle | No | GitHub handle |
scrapecreators_get_v1_github_user_followersGitHub — FollowersInspect
Retrieves public GitHub followers for a user. Each follower includes login, avatar, user URL, type, and GitHub IDs. Pass username, handle, or a full GitHub user url. Supports cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | GitHub user URL, e.g. https://github.com/torvalds. | |
| cursor | No | Cursor from the previous response. Defaults to 1. | |
| handle | No | GitHub username/handle of the user you want the followers for |
scrapecreators_get_v1_github_user_followingGitHub — FollowingInspect
Retrieves public accounts followed by a GitHub user. Each account includes login, avatar, profile URL, type, and GitHub IDs. Pass username, handle, or a full GitHub profile url. Supports cursor pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | GitHub profile URL | |
| cursor | No | Cursor from the previous response. Defaults to 1. | |
| handle | No | GitHub handle |
scrapecreators_get_v1_github_user_pull_requestsGitHub — Pull RequestsInspect
Searches public GitHub pull requests authored by a user using GitHub's public search index. Pass username, handle, or url. Optional since and until filters use YYYY-MM-DD created dates. Results include the PR title, repo, state, created_at, and url, sorted by newest created first. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| since | No | Only return pull requests created on or after this date. Use YYYY-MM-DD. | |
| until | No | Only return pull requests created on or before this date. Use YYYY-MM-DD. | |
| cursor | No | Cursor from the previous response. Defaults to 1. | |
| handle | Yes | GitHub username/handle of the user you want pull requests for |
scrapecreators_get_v1_github_user_repositoriesGitHub — RepositoriesInspect
Retrieves a user's public repositories with repo metadata like description, language, stars, forks, topics, license, visibility, default branch, and timestamps. Pass username, handle, or url. Supports pagination with cursor, plus GitHub's type, sort, and direction parameters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | GitHub user URL, e.g. https://github.com/kentcdodds. | |
| sort | No | Sort by created, updated, pushed, or full_name. Defaults to updated. | |
| type | No | Repository type. Defaults to owner. GitHub also supports all and member. | |
| cursor | No | Cursor from the previous response. Defaults to 1. | |
| handle | No | GitHub username/handle of the user you want the repositories for | |
| direction | No | Sort direction: ascending or descending. |
scrapecreators_get_v1_google_adGoogle Ad Library — Ad DetailsInspect
Retrieves detailed information about a specific Google ad including advertiserId, creativeId, format, firstShown, lastShown, and overallImpressions. When Google publishes political-ad transparency data, spend contains the currency and amount bounds, while targeting contains included and excluded age, gender, and location criteria. Targeted locations include their Google criterion ID, display name, full name, and country codes. Optional fields are null when Google does not publish them. regionStats and platformImpressions use lower and upper impression bounds. Variations are best-effort, omit u Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The url of the ad | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_google_adlibrary_advertisers_searchGoogle Ad Library — Advertiser SearchInspect
Searches the Google Ad Transparency Library for advertisers by name. Returns a list of matching advertisers with their name, advertiser_id, and region, plus a list of associated website domains. Use the returned advertiser_id to look up a company's ads. Defaults to US when region is not passed, so pass a 2-letter country code like AU or CA when searching for advertisers in another region. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The query to search for | |
| region | No | 2-letter country code to search in. Defaults to US when omitted. |
scrapecreators_get_v1_google_company_adsGoogle Company AdsInspect
Fetches public ads for a company from the Google Ad Transparency Library by domain or advertiser_id. Each ad includes advertiserId, creativeId, format, adUrl, advertiserName, domain, firstShown, and lastShown. Costs 25 credits per request when get_ad_details=true; without it, only advertiserId and creativeId are returned at 1 credit. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | The topic to search for. If you search for 'political', you will also need to pass a 'region', like 'US' or 'AU' | |
| cursor | No | Cursor to paginate through results | |
| domain | No | The domain of the company | |
| format | No | Ad format to search for. | |
| region | No | The region to search for. Defaults to anywhere | |
| end_date | No | End date to search for. Format: YYYY-MM-DD | |
| platform | No | Platform to search for. | |
| start_date | No | Start date to search for. Format: YYYY-MM-DD | |
| advertiser_id | No | The advertiser id of the company | |
| get_ad_details | No | Set to true to get the ad details. Will cost 25 credits. |
scrapecreators_get_v1_google_searchGoogle — SearchInspect
Performs a Google search and returns organic results with url, title, and description for each result. Supports an optional region parameter (2-letter country code) to get localized results from a specific country. Pages 1 through 11 are supported; requests for page 12 or greater return a 400 response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number to retrieve. Must be between 1 and 11; page 12 or greater returns a 400 response. | |
| query | Yes | Search query | |
| region | No | 2 letter country code, ie US, UK, CA, etc This will show results from that country | |
| date_posted | No | Date posted |
scrapecreators_get_v1_instagram_audio_reelsInstagram — Get Reels By Audio IdInspect
Fetches the reels Instagram exposes for an audio page like instagram.com/reels/audio/{audio_id}/. Pass the audio_id from that URL. Use cursor from the previous response to request the next page when Instagram returns one. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Pagination cursor returned by Instagram from the previous response. | |
| audio_id | Yes | The audio id from the Instagram audio page URL. |
scrapecreators_get_v1_instagram_basic_profileInstagram — Basic ProfileInspect
Fetches a lightweight Instagram profile summary by user ID, returning username, full name, biography, profile picture URL, verification status, follower count, following count, media count, and account privacy and type. Ideal for quick lookups or enrichment when you already have the numeric user ID. Use this when speed matters and you do not need posts. It skips the post-fetching and enrichment calls made by Profile, so it is usually faster. Response times can vary. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | No | Instagram user id | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_instagram_postInstagram Post / Reel DetailsInspect
Fetches detailed metadata for a single Instagram post or reel by shortcode or URL. Returns caption text, like count, comment count, video URL, video play count, video duration, display images, owner info, tagged users, carousel sidecar children when applicable, and the published time in data.xdt_shortcode_media.created_at as an ISO 8601 UTC date. The original Unix timestamp remains available in data.xdt_shortcode_media.taken_at_timestamp. Play counts are Instagram-only views and exclude cross-posted Facebook views. Set include_play_count=false to omit the play count and skip its addition
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Instagram post or reel URL | |
| trim | No | Set to true to get a trimmed response | |
| region | No | 2 letter country code to set the proxy in | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) | |
| download_media | No | Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise. | |
| include_play_count | No | Set to false to omit `video_play_count` and skip its additional fetch for a faster response. Defaults to true. |
scrapecreators_get_v1_instagram_post_comment_repliesInstagram — Comment RepliesInspect
Retrieves the public replies to a specific Instagram comment. Pass the post or reel URL and the parent comment's id from the Comments endpoint. Returns reply text, timestamps, engagement counts, parent comment ID, and user details. Paginate with cursor when has_more is true.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The Instagram post or reel URL | |
| cursor | No | The cursor to get more replies. Get `cursor` from the previous response. | |
| comment_id | Yes | The parent comment ID from the Comments endpoint |
scrapecreators_get_v1_instagram_profileInstagram — ProfileInspect
After recent Instagram changes, fetching creator metadata and posts requires several requests to Instagram, so this endpoint can be slower. If you only need profile details without posts, use Basic Profile with the numeric userId for a usually faster lookup. Retrieves comprehensive public Instagram profile information including biography, bio links, follower and following counts, verification status, and profile picture URLs. Private profiles also return all available public profile metadata through the same existing data.user mappe Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response | |
| handle | Yes | Instagram handle | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_instagram_profile_post_countInstagram — Profile Post CountInspect
Returns the post count shown on a public Instagram profile. Use this endpoint when Profile returns media_count as null or edge_owner_to_timeline_media.count contains only the current batch size. This endpoint makes a separate Instagram profile-page request so it does not add latency to the main Profile endpoint. Full values such as 12,345 Posts return the exact integer with is_estimated set to false. For profiles with more than 10,000 posts, Instagram may expose only a compact value such as 12K Posts or 1.2M Posts. Set allow_estimated=true to return the scaled integer with is_estimated set to Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Instagram handle | |
| allow_estimated | No | Set to true to return scaled estimates when Instagram abbreviates counts for profiles with more than 10,000 posts. Defaults to false; false or omitted returns an uncharged 422 when only an estimate is available. |
scrapecreators_get_v1_instagram_reels_trendingInstagram — Trending ReelsInspect
Instagram — Trending Reels Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
scrapecreators_get_v1_instagram_searchInstagram — Search InstagramInspect
Use this for Instagram-native account, hashtag, or place lookup. It returns ranked users, hashtags, places, and keyword suggestions from Instagram itself. It is not Google-indexed, does not require an Instagram login, returns one page only, and does not return posts. For an Instagram-curated topic page with posts, use /v1/instagram/search/popular. For the same native account results in a profile-only response, use /v1/instagram/search/profiles. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The username, hashtag, place, or keyword to search for. |
scrapecreators_get_v1_instagram_search_hashtagInstagram — Search Hashtag PostsInspect
Use this when you know the exact hashtag and want Google-indexed public Instagram posts or reels, optional date filters, and pagination. It returns post details such as caption, engagement, owner, and post time. Results are best-effort and not a complete Instagram-native hashtag feed. For an Instagram-curated topic page with generated context and suggested terms, use /v1/instagram/search/popular. Pass media_type=reels to only return reels. Cursors are limited to pages 1 through 11; cursor 12 or greater returns a 400 response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | The cursor returned by the previous response. It is the next Google results page number and cannot exceed 11; cursor 12 or greater returns a 400 response. | |
| hashtag | Yes | The hashtag to search for. Include or omit the #. | |
| media_type | No | Use all to search public posts and reels, or reels to only return reels. Defaults to all. | |
| date_posted | No | Only return Google-indexed posts found in this relative window. |
scrapecreators_get_v1_instagram_search_popularInstagram — Popular SearchInspect
Use this to explore an Instagram topic and the posts Instagram curates for it. It scrapes the public /popular/{query} page without requiring an Instagram login. The first page returns the topic title, numeric total media count, Instagram's generated description and sources, suggested terms, posts, and an opaque cursor. Pass that cursor with the same query to fetch more posts. Later pages return query, posts, cursor, and has_more only. For an exact hashtag through Google-indexed results, use /v1/instagram/search/hashtag. For reels only, use /v2/instagram/reels/search. Each successful request co Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The Popular topic to search for. | |
| cursor | No | The opaque cursor returned by the previous response. Use it with the same query to fetch the next page of posts. |
scrapecreators_get_v1_instagram_search_profilesInstagram — Search Instagram ProfilesInspect
Use this for Instagram-native profile lookup. It returns every account in Instagram's first ranked native result set, then performs bounded best-effort enrichment for the first 10 accounts to preserve the previous profile fields such as biography, bio links, account flags, and follower/following/media counts. Results after the first 10 retain native ID, username, full name, verification status, profile photo, and URL, while unavailable detail fields are null or empty. It does not search Google-indexed bios or captions, Google title/description fields are null, and pagination is not supported. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The profile name or username to search for. |
scrapecreators_get_v1_instagram_user_embedInstagram — Embed HTMLInspect
Returns the raw HTML embed snippet for an Instagram user's profile widget. The response contains a single html string that can be inserted into a webpage to render an embeddable Instagram profile card. Requires the user's handle as input. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Instagram handle |
scrapecreators_get_v1_instagram_user_highlight_detailInstagram — Highlights DetailsInspect
Fetches the full contents of a specific Instagram story highlight album by its ID. Returns the highlight's cover image, title, user info, and an items array containing each story with its media type, image or video URLs, dimensions, timestamp, and sticker/interactive element data. Useful for archiving or analyzing individual highlight reels. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The ID of the highlight to get details for |
scrapecreators_get_v1_instagram_user_highlightsInstagram — Story HighlightsInspect
Lists all story highlight albums for an Instagram user. Each highlight includes its ID, title, cover thumbnail URL, and owner info with username and profile picture. Accepts either a user_id or handle; providing user_id yields faster responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | No | Instagram handle. Use user_id for faster response times. | |
| user_id | No | Instagram user id. Use for faster response times. |
scrapecreators_get_v1_instagram_user_reelsInstagram — ReelsInspect
Returns a paginated list of a user's public Instagram reels (short-form videos). Each reel includes its shortcode, play count, like count, comment count, video versions with download URLs, thumbnail image, owner info, and the published time in items[].media.created_at as an ISO 8601 UTC date. With trim=true, use items[].created_at. The original Unix timestamp remains available as taken_at. Note that reel captions are not returned by this endpoint. Play counts are Instagram-only views and exclude cross-posted Facebook views. Supports cursor-based pagination via max_id; providing a user_
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| handle | No | Instagram handle. Use user_id for faster response times. | |
| max_id | No | Max id to get more reels. Get 'max_id' from previous response. | |
| user_id | No | Instagram user id. Use this for faster response times. |
scrapecreators_get_v1_instagram_user_tagged_postsInstagram — User Tagged PostsInspect
Returns up to 10 public posts per page from an Instagram user's Tagged tab. Each item is a flat post object with its shortcode, caption, media type, engagement counts, media URLs, and owner details. Keep passing the returned cursor to fetch additional pages until has_more is false. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Cursor returned by the previous response. | |
| user_id | Yes | Numeric Instagram user ID. |
scrapecreators_get_v1_kick_clipKick — ClipInspect
Fetches detailed data for a Kick clip by URL, including video, metadata, and channel info. Returns clip id, title, clip_url, thumbnail_url, video_url, view_count, likes_count, duration, privacy status, and is_mature flag. Also includes category details (name, slug), creator info (username), and channel info (username, profile_picture). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Kick clip URL |
scrapecreators_get_v1_komiKomi — Komi pageInspect
Scrapes a Komi page by URL, extracting the creator's profile, social links, and featured content. Returns id, username, avatar, displayName, bio, and social accounts (instagram, tiktok, youtube, twitter, facebook, snapchat). Also includes links, an array of link and product objects each with id, url, title, type, thumbnail, and optional price and currency for products. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL to Komi page | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_kwai_postKwai — PostInspect
Fetches public Kwai post details including caption, media URLs, cover images, counts, author info, and music metadata. Uses Kwai's public web API endpoint, not HTML scraping. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Kwai post URL |
scrapecreators_get_v1_kwai_profileKwai — ProfileInspect
Fetches public Kwai profile data including username, bio, avatar, verification status, gender, and public counts. Uses Kwai's public web API endpoint, not HTML scraping. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Kwai profile URL. Use this or handle. | |
| handle | No | Kwai profile handle. Use this or url. |
scrapecreators_get_v1_kwai_user_postsKwai — User PostsInspect
Fetches a paginated list of public Kwai posts for a user, including captions, media URLs, covers, counts, author info, and the next cursor when more results are available. Uses Kwai's public web API endpoint, not HTML scraping. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Kwai profile URL. Use this or handle. | |
| count | No | Number of posts to return, max 50 | |
| cursor | No | Cursor from the previous response for the next page | |
| handle | No | Kwai profile handle. Use this or url. |
scrapecreators_get_v1_linkbioLinkbio — Linkbio pageInspect
Scrapes a Linkbio (lnk.bio) page by URL, extracting the creator's profile and all their links. Returns handle, id, social accounts (instagram, tiktok, youtube, twitter, whatsapp), email, website, and links — an array of link objects each with url and text. Contact fields come from the submitted public Linkbio page. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL to Linkbio (lnk.bio) page | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_linkedin_adLinkedIn Ad Library — Ad DetailsInspect
Retrieves detailed information about a specific LinkedIn ad by URL. Returns id, description, headline, adType, advertiser, and targeting with language, location, and audience criteria. Also includes totalImpressions, impressionsByCountry, adDuration, startDate, and endDate. Date and impression fields are nullable when LinkedIn does not expose them on the public ad page. The existing image, video, organicVideo, preRollVideo, and carouselImages fields keep their previous values. paidForBy is the public paying entity when LinkedIn shows one, without the 'Paid for by' prefix. targetingTable lists Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The url of the ad |
scrapecreators_get_v1_linkedin_ads_searchLinkedIn Ad Library — Search AdsInspect
Searches the LinkedIn Ad Library by company name, keyword, or companyId with optional country and date filters. Custom date filtering requires both startDate and endDate. LinkedIn accepts dates from the date one year ago through yesterday. Each ad includes id, description, headline, adType, advertiser, targeting details, image or video URLs, totalImpressions, and impressionsByCountry. Date and impression fields are nullable when LinkedIn does not expose them on the public ad page. Supports pagination via paginationToken. Search results keep a consistent field set when detail hydration fails, w Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| company | No | The company name to search for. 'Microsoft' for example | |
| endDate | No | End date in YYYY-MM-DD format. Must be used with startDate and cannot be today or a future date. | |
| keyword | No | The keyword to search for | |
| companyId | No | The company id to search for | |
| countries | No | Comma separated list of countries. Example: US,CA,MX | |
| startDate | No | Start date in YYYY-MM-DD format. Must be used with endDate and cannot be earlier than the date one year ago. | |
| paginationToken | No | Pagination token to paginate through results |
scrapecreators_get_v1_linkedin_companyLinkedIn — Company PageInspect
Fetches a LinkedIn company page with details including name, description, logo, cover image, slogan, location, headquarters, employee count (headcount/staff size), website, industry, company type, founded year, specialties, funding rounds with investors, featured employees, recent posts, and similar company pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the LinkedIn company page to get |
scrapecreators_get_v1_linkedin_company_postsLinkedIn — Company PostsInspect
Retrieves paginated posts from a LinkedIn company or school page, including each post's URL, ID, publication date, and full text content. Accepts /company/ and /school/ URLs, such as https://www.linkedin.com/school/oxfordsbs/ for Oxford Saïd Business School. Supports page-based pagination up to a maximum of 7 pages due to a LinkedIn platform limitation. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The LinkedIn company (/company/) or school (/school/) page URL, for example https://www.linkedin.com/school/oxfordsbs/ | |
| page | No | The page number to get |
scrapecreators_get_v1_linkedin_postLinkedIn — PostInspect
Fetches a single LinkedIn post or article, returning the title, headline, full description text, author info with follower count, publication date, like count (reactions), comment count, and individual comments. For public feed posts, activityUrn and contentUrn expose LinkedIn's public activity and underlying share or ugcPost URNs when present; either can be null when LinkedIn does not expose it. Also includes related articles from the same author in moreArticles. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the LinkedIn post to get |
scrapecreators_get_v1_linkedin_post_transcriptLinkedIn — Post TranscriptInspect
Fetches the transcript from a LinkedIn post video when LinkedIn exposes one publicly. Returns null with transcriptNotAvailable when the post has no transcript, and only deducts credits when a transcript is returned. Returned native captions cost 1 credit; empty transcripts and errors cost 0 credits. This endpoint does not use AI transcription. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the LinkedIn post to get the transcript from |
scrapecreators_get_v1_linkedin_profileLinkedIn — Person's ProfileInspect
Retrieves a person's public LinkedIn profile data, including their name, photo, location, follower count (followers), about/bio summary, recent posts, work experience, education, articles, activity feed, publications, projects, recommendations, and similar profiles. Only returns publicly available information visible in an incognito browser. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the LinkedIn profile to get |
scrapecreators_get_v1_linkedin_search_postsLinkedIn — Search PostsInspect
Finds public LinkedIn posts, feed updates, and Pulse articles by keyword using Google Search, then returns post details such as description, author, media, images, like count, comment count, and published date when LinkedIn exposes them publicly. Results depend on what Google has indexed, so this is best-effort and not a complete LinkedIn-native search. Use date_posted for recent posts and pass the returned cursor to fetch the next page. Cursors are limited to pages 1 through 11; cursor 12 or greater returns a 400 response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Keyword or phrase to search for in public LinkedIn posts | |
| cursor | No | The cursor returned from the previous response. The maximum cursor is 11; cursor 12 or greater returns a 400 response. | |
| date_posted | No | Date posted filter based on Google-indexed results |
scrapecreators_get_v1_linkmeLinkme — ProfileInspect
Retrieves a Linkme profile by URL, including identity, social links, and contact details. Returns profile with id, firstName, username, bio, profileVisitCount, profileImage, verifiedAccount, and isAmbassador flag. Also includes infoLinks (email addresses) and webLinks, an array of categorized social platform links (Spotify, Instagram, YouTube, Twitter, Facebook, and more) each with linkValue and faceValue. Contact fields come from the submitted public Linkme profile. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Linkme profile URL | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_linktreeLinktree — Linktree pageInspect
Scrapes a Linktree page by URL, extracting the creator's profile and all their links. Returns id, username, profilePictureUrl, description, verticals, timezone, and links — an array of link objects each with id, type, title, and url. Also includes detected social accounts (instagram, tiktok, spotify, youtube, soundcloud, apple_music) and email_address. Contact fields come from the submitted public Linktree page. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL to Linktree page | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_pillarPillar — Pillar pageInspect
Scrapes a Pillar page by URL, extracting the creator's profile, social links, and products. Returns id, first_name, last_name, email, location, and social accounts (tiktok, spotify, twitter, youtube, facebook, linkedin, instagram, and more). Also includes links with click counts and products with title, price, description, and image. Contact fields come from the submitted public Pillar page. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL to Pillar page | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_pinterest_boardPinterest — BoardInspect
Fetches a paginated list of pins from a Pinterest board by URL, returning each pin's id, description, title, images, board info, pin_join annotations, and aggregated_pin_data. Supports pagination via cursor and a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the board to get | |
| trim | No | Set to true for a trimmed down version of the response | |
| cursor | No | The cursor to get the next page of results |
scrapecreators_get_v1_pinterest_pinPinterest — PinInspect
Fetches detailed information about a single Pinterest pin by URL, returning title, description, link, dominantColor, originPinner, pinner, images at multiple resolutions (imageSpec_236x through imageSpec_orig), and pinJoin with visual annotations. Supports a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Pinterest pin URL | |
| trim | No | Set to true for a trimmed down version of the response | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_pinterest_searchPinterest — SearchInspect
Searches Pinterest for pins matching a query, returning results with id, url, title, description, images, link, domain, board info, and pinner details. Supports pagination via cursor and a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| query | Yes | Search query | |
| cursor | No | Cursor |
scrapecreators_get_v1_pinterest_user_boardsPinterest — User BoardsInspect
Fetches a paginated list of boards for a Pinterest user, returning each board's name, url, description, pin_count, follower_count, owner info, cover_images, and created_at. Supports pagination via cursor and a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| handle | Yes | The username of the user to get boards for. (e.g. broadstbullycom from https://www.pinterest.com/broadstbullycom/) |
scrapecreators_get_v1_reddit_postReddit — PostInspect
Retrieves public Reddit post details by URL without fetching or returning comments. Returns the text post body in selftext when present, plus the title, author, subreddit, score, upvote ratio, comment count, timestamps, permalink, and post flags. Accepts canonical Reddit post URLs and Reddit mobile share URLs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Reddit post URL |
scrapecreators_get_v1_reddit_post_commentsReddit — Post CommentsInspect
Retrieves comments and post details from a Reddit post by URL. Returns the post with title, author, score, ups, upvote_ratio, num_comments, and created_utc, plus a comments array where each comment includes author, body, body_html, score, created_utc, parent_id, permalink, and nested replies. Both GET and POST are supported. Use GET for normal requests. Pass one opaque cursor exactly as returned by more.cursor or replies.more.cursor to load the next page. Cursor batching and comma-separated cursor values are not supported. If an opaque cursor becomes too large after extensive pagination, use P Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Reddit post URL | |
| trim | No | Set to true for a trimmed down version of the response | |
| cursor | No | One opaque cursor returned by the previous response to get more comments or replies. Do not combine multiple cursors. |
scrapecreators_get_v1_reddit_post_transcriptReddit — Post TranscriptInspect
Gets the transcript from a Reddit video post or direct v.redd.it URL when Reddit exposes a VTT caption file. Returns the raw WebVTT in raw_vtt plus a parsed plain-text transcript. If Reddit does not expose captions for the video, transcript is null and transcriptNotAvailable is true. Returned native captions cost 1 credit; empty transcripts and errors cost 0 credits. This endpoint does not use AI transcription. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Reddit post URL or direct v.redd.it video URL | |
| language | No | 2 letter language code. Defaults to en. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_reddit_searchReddit — SearchInspect
Searches across all of Reddit for posts or comments matching a query. Set filter to posts (the default) or comments. Post results include title, author, selftext, subreddit, score, ups, num_comments, created_utc, url, permalink, and is_video. Comment results include the matching body, author, votes, timestamps, comment URL, parent relationship, and post/subreddit context. Comment searches support relevance, new, and top sorting. Timeframe filtering applies to post searches. Pagination uses the after token, and trim returns a lighter response. upvote_ratio and subreddit_subscribers are currentl Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort by. Comment search supports relevance, new, and top; comment_count is for post search only. | |
| trim | No | Set to true for a trimmed down version of the response | |
| after | No | Used to paginate to next page | |
| query | Yes | Search query | |
| filter | No | Search posts or comments | |
| timeframe | No | Post search timeframe |
scrapecreators_get_v1_reddit_subredditReddit — Subreddit PostsInspect
Fetches posts from a subreddit with sorting and filtering options. Each post includes title, author, link_flair_text when Reddit exposes it, selftext, score, ups, upvote_ratio, num_comments, created_utc, url, permalink, subreddit_subscribers, and is_video. Supports sort (best, hot, new, top, rising), timeframe filtering, pagination via the after token, and a trim parameter for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order | |
| trim | No | Set to true for a trimmed down version of the response | |
| after | No | After to get more posts. Get 'after' from previous response. | |
| subreddit | Yes | Subreddit name | |
| timeframe | No | Timeframe to get posts from | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_reddit_subreddit_detailsReddit — Subreddit DetailsInspect
Retrieves metadata about a subreddit by name or URL. The subreddit name must be case-sensitive. Returns display_name, description, weekly_active_users, weekly_contributions, rules, icon_img, header_img, advertiser_category, submit_text, and created_at. Subscriber counts are not available. weekly_active_users and weekly_contributions measure weekly activity, not total subscribers. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Subreddit URL | |
| subreddit | No | Subreddit name. MUST be case sensitive. So 'AskReddit' not 'askreddit'. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_reddit_subreddit_searchReddit — Subreddit SearchInspect
Searches within a specific subreddit for posts, comments, and media matching a query. Returns posts with title, votes, num_comments, url, and created_at; comments with author, body, votes, and parent post info; and media with title, media_type, image dimensions, and gallery_count. Supports sort, timeframe filtering, and cursor-based pagination. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order. For posts/media: relevance, hot, top, new, comments. For comments: relevance, top, new | |
| query | No | Search query to find matching content | |
| cursor | No | Cursor to get more results. Get 'cursor' from previous response. | |
| subreddit | Yes | Subreddit name (e.g. 'Fitness', not 'r/Fitness' or a full URL) | |
| timeframe | No | Timeframe to filter results |
scrapecreators_get_v1_rumble_channel_videosRumble — Channel VideosInspect
Gets videos from a Rumble channel by handle or URL. Returns channel metadata, videos, shorts, and a numeric cursor for the next page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Rumble channel URL. If you'd prefer to use the handle instead, use the handle parameter. | |
| cursor | No | Cursor from the previous response. This is the next page number, like 2 or 3. | |
| handle | No | Rumble channel handle. If you'd prefer to use the URL instead, use the url parameter. |
scrapecreators_get_v1_rumble_searchRumble — SearchInspect
Searches Rumble videos by keyword. Returns matching videos and shorts with title, URL, thumbnail, channel, published date, viewCountText, viewCountInt, and a numeric cursor for the next page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query. | |
| cursor | No | Cursor from the previous response. This is the next page number, like 2 or 3. |
scrapecreators_get_v1_rumble_videoRumble — VideoInspect
Gets Rumble video details by URL. Returns title, description, thumbnail, channel, publish date, view count, likes, dislikes, captions, and media metadata when available. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Rumble video URL. |
scrapecreators_get_v1_rumble_video_commentsRumble — CommentsInspect
Gets all top level comments for a Rumble video by URL. Returns comment text, author, createdAt, createdAtText, likeCount, dislikeCount, and replyCount when comment bodies are public. If Rumble requires sign-in to view the comments, this endpoint returns HTTP 403 with error forbidden and does not charge credits. This is different from a public video with no comments, which returns a successful empty comments array.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Rumble video URL. |
scrapecreators_get_v1_rumble_video_transcriptRumble — TranscriptInspect
Gets a Rumble video's transcript when captions are available. If Rumble does not expose captions for the video, transcript will be null and you will not be charged. Returned native captions cost 1 credit; empty transcripts and errors cost 0 credits. This endpoint does not use AI transcription. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Rumble video URL. |
scrapecreators_get_v1_snapchat_profileSnapchat — User ProfileInspect
Retrieves a Snapchat user's public profile by handle, including identity, stories, and spotlight content. Returns userProfile with username, title, snapcodeImageUrl, subscriberCount, bio, and profilePictureUrl. Also includes highlightStoryMetadata with individual story snaps (mediaUrl, mediaType, thumbnailUrl) and spotlightStoryMetadata with video details and engagement stats (viewCount, shareCount, commentCount). Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Snapchat username |
scrapecreators_get_v1_snapchat_spotlightSnapchat — Spotlight by LinkInspect
Fetches public data for a Snapchat Spotlight video by URL. Returns the snap id, description, creator, engagement counts, thumbnail, and content URL when Snapchat exposes them publicly. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Snapchat Spotlight URL. |
scrapecreators_get_v1_snapchat_spotlight_commentsSnapchat — Spotlight Comments by LinkInspect
Fetches public comments from Snapchat's Spotlight comments API by URL. Returns the snap id, comments, a cursor for the next page, and hasMore. Pass the returned cursor back as the cursor param to load more comments. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Snapchat Spotlight URL. | |
| cursor | No | Pagination cursor from the previous response. |
scrapecreators_get_v1_soundcloud_artistSoundCloud — ArtistInspect
Fetches detailed information about a SoundCloud artist by its handle or URL. Returns artist metadata including id, name, followers, etc Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | SoundCloud artist URL. If you'd prefer to use the handle instead, you can use the handle parameter instead. | |
| handle | No | SoundCloud artist handle. If you'd prefer to use the URL instead, you can use the url parameter instead. |
scrapecreators_get_v1_soundcloud_artist_tracksSoundCloud — Artist TracksInspect
Fetches tracks/songs for a SoundCloud artist by handle or URL. Returns the artist profile, track list, and pagination info from SoundCloud. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | SoundCloud artist tracks URL. If you'd prefer to use the handle instead, you can use the handle parameter instead. | |
| cursor | No | Cursor to get more tracks. Get 'cursor' from previous response. | |
| handle | No | SoundCloud artist handle. If you'd prefer to use the URL instead, you can use the url parameter instead. |
scrapecreators_get_v1_soundcloud_trackSoundCloud — TrackInspect
Fetches detailed information about a SoundCloud track/song by URL. Returns track title, plays, likes, reposts, comments, artwork, artist, and other SoundCloud metadata. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | SoundCloud track URL. |
scrapecreators_get_v1_spotify_albumSpotify — AlbumInspect
Retrieves detailed information about a Spotify album by its id or URL, including album metadata, artists, release date, cover art, copyright info, tracks, and sharing details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify album id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Spotify album URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
scrapecreators_get_v1_spotify_artistSpotify — ArtistInspect
Retrieves detailed information about a Spotify artist by their handle, including name, followers count, genres, and related artists. Accepts a handle as input and returns artist metadata such as id, name, followers, genres, and related artists. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify artist id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Spotify artist URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
scrapecreators_get_v1_spotify_playlistSpotify — PlaylistInspect
Retrieves public Spotify playlist metadata and up to 50 tracks by playlist id or URL. For playlists with more tracks, pass the returned cursor into the next request until cursor is null. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify playlist id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Spotify playlist URL. If you'd prefer to use the id instead, you can use the id parameter instead. | |
| cursor | No | Cursor returned by the previous response. Omit it for the first page. |
scrapecreators_get_v1_spotify_podcastSpotify — PodcastInspect
Spotify — Podcast Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify podcast id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Spotify podcast URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
scrapecreators_get_v1_spotify_podcast_episodesSpotify — Podcast EpisodesInspect
Returns episodes for a Spotify podcast. Pass the cursor returned by a response to get the next page. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify podcast id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Spotify podcast URL. If you'd prefer to use the id instead, you can use the id parameter instead. | |
| cursor | No | Cursor returned by the previous response. Omit for the first page. |
scrapecreators_get_v1_spotify_searchSpotify — SearchInspect
Search Spotify for tracks, artists, albums, episodes, podcasts, and audiobooks. Use type=podcasts when you need podcast ids for the podcast endpoints. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query |
scrapecreators_get_v1_spotify_trackSpotify — TrackInspect
Retrieves detailed information about a Spotify track by its id or URL, including track metadata, artists, album info, duration, playability, and sharing details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Spotify track id. If you'd prefer to use the URL instead, you can use the url parameter instead. | |
| url | No | Spotify song URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
scrapecreators_get_v1_telegram_channelTelegram — Channel DetailsInspect
Retrieves public Telegram channel or group metadata including its name, description, avatar, verification status, subscriber or member count, and public media counters. This endpoint uses Telegram's public web preview and does not use a logged-in Telegram account. Private channels, invite-only groups, numeric IDs, and channels with no public web preview are not supported. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Public Telegram handle, @handle, or t.me channel URL. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_telegram_channel_postsTelegram — Channel PostsInspect
Retrieves one public web-preview page of Telegram posts with text, publish date, views, reactions when exposed, forwards, media previews, and link previews. Pass the returned cursor to fetch the previous page. Empty and terminal pages are not charged. Telegram does not expose every field on every public post, so reactions and downloadable media URLs can be absent. This endpoint does not support private or invite-only channels and groups. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Numeric cursor returned by the previous page. Omit it for the latest posts. | |
| handle | Yes | Public Telegram handle, @handle, or t.me channel URL. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_telegram_postTelegram — Post DetailsInspect
Retrieves one public Telegram post with its text, publish date, views, reactions when exposed, forward source, media previews, and link preview. This endpoint uses Telegram's public post widget without a logged-in account. Private and invite-only posts are not supported. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public Telegram post URL. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_threads_postThreads — PostInspect
Fetches a single Threads post by URL, returning the post's caption, like_count, view_counts, reshare_count, direct_reply_count, image_versions2, text_post_app_info, and taken_at. Also includes comments, threadItems, and relatedPosts arrays. threadItems contains public continuation posts by the original author and stays separate from comments. Supports a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the post to get | |
| trim | No | Set to true for a trimmed down version of the response | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_threads_profileThreads — ProfileInspect
Retrieves a Threads user's public profile including username, full_name, biography, profile_pic_url, follower_count, is_verified, bio_links, and hd_profile_pic_versions. Also indicates whether the account is a threads-only user via is_threads_only_user. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Threads username | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_threads_searchThreads — Search by KeywordInspect
Searches Threads for posts matching a keyword, returning up to 10 results with caption text, like_count, reshare_count, direct_reply_count, user info, and image_versions2. Supports optional start_date and end_date filters plus a trim option. Only 10 results are returned per request due to public API limitations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| query | Yes | Keyword to search for | |
| end_date | No | End date to search for | |
| start_date | No | Start date to search for |
scrapecreators_get_v1_threads_search_usersThreads — Search UsersInspect
Searches for Threads users by username, returning matching profiles with username, full_name, profile_pic_url, is_verified, and pk. Useful for finding user accounts before fetching their profile or posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Username to search for |
scrapecreators_get_v1_threads_user_postsThreads — PostsInspect
Fetches the most recent posts from a Threads user, returning id, caption text, code, like_count, reshare_count, direct_reply_count, repost_count, image_versions2, video_versions, and taken_at. Only the last 20-30 posts are publicly visible. Supports a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| handle | Yes | Threads username |
scrapecreators_get_v1_tiktok_ad_library_adTikTok Ad Library — Ad Library AdInspect
Fetches one TikTok ad by ID or URL. It first checks Creative Center Top Ads (ads.tiktok.com), then TikTok's public transparency Ads Library (library.tiktok.com) when the ID is not a Top Ads material. Both sources return the same response shape. Fields TikTok does not expose for a public Ads Library ad are null, empty, or false as appropriate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ad_id | Yes | Creative Center Top Ads material ID or URL, or a public Ads Library ad ID or library.tiktok.com detail URL. |
scrapecreators_get_v1_tiktok_ad_library_searchTikTok Ad Library — Ad Library SearchInspect
Searches TikTok's public Ads Library using either query for a general search or advertiser_name for advertiser-specific results. Advertiser-name searches resolve the name through TikTok's advertiser typeahead first, then search the selected advertiser entity and return adv_biz_ids on each ad. You can pass adv_biz_ids with advertiser_name to pin the exact advertiser shown in TikTok's See all ads link. TikTok requires the name with the ID and ignores an ID-only search, so provide exactly one of query or advertiser_name. If TikTok has no matching advertiser entity, the API falls back to TikTok's Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | General ad search. Provide either query or advertiser_name, not both. | |
| cursor | No | Opaque cursor returned from the previous response. | |
| adv_biz_ids | No | TikTok advertiser business ID from a See all ads link. Use it with advertiser_name to pin the exact advertiser. Required companion: advertiser_name; ID-only searches return 400 because TikTok ignores the ID without the name. | |
| advertiser_name | No | Advertiser name to resolve through TikTok's typeahead and search by advertiser entity. Falls back to TikTok's name search when no entity matches. Provide either advertiser_name or query, not both. |
scrapecreators_get_v1_tiktok_collection_videosTikTok — Collection VideosInspect
Fetches the videos saved in a public TikTok collection, which TikTok also calls a playlist. Pass the collection URL. Returns videos using TikTok's native web video object format, including id, desc, author, stats, and video. To fetch the next page, pass the previous response's max_cursor as cursor when has_more is true.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public TikTok collection URL | |
| cursor | No | Cursor to get more videos. Use max_cursor from the previous response. |
scrapecreators_get_v1_tiktok_creators_popularTikTok — Get popular creatorsInspect
Discovers trending and popular TikTok creators, filterable by follower count range, creator country, and audience country. Returns creator_list, an array of creator objects each with nickname, unique_id, follower_count, likes_count, video_views, engagement_rate, and avatar URLs. Sortable by engagement, follower count, or average views.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number | |
| sortBy | No | Sort creators by engagement, follower count, or average views | |
| followerCount | No | Filter by follower count range | |
| creatorCountry | No | Country code of the creator | |
| audienceCountry | No | Country code of the audience/follower |
scrapecreators_get_v1_tiktok_get_trending_feedTikTok — Trending FeedInspect
Fetches TikTok's trending/For You feed for a given region — useful for discovering viral content and what's currently popular. Returns aweme_list, an array of video objects each with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count, collect_count), video (playback and download URLs, cover), author info, and image_post_info for photo carousels.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response. | |
| region | Yes | Where you want the proxy to be. This doesn't mean that you will only see TikToks from this region, you will just see the content that isn't banned in that region. |
scrapecreators_get_v1_tiktok_liveTikTok — Live InfoInspect
Gets curated room-level info for a TikTok live using TokAPI's live info endpoint. Use /v1/tiktok/user/live first to find the room_id. If you only have a TikTok handle and need the user's numeric id, use /v1/tiktok/profile first to get user.id. This endpoint is separate from /v1/tiktok/user/live because it uses a different upstream call and returns a smaller response with the most relevant fields: room_id, like_count, viewer_count, status, title, cover_url, and owner.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | TikTok live room id. Get this from `/v1/tiktok/user/live` in `liveRoomUserInfo.roomId` or `liveRoom.id` when the user is live. | |
| user_id | Yes | TikTok numeric user id for the live owner. Get this from `/v1/tiktok/profile` in `user.id`. |
scrapecreators_get_v1_tiktok_productTikTok Shop — Product DetailsInspect
Fetches full details for a specific US TikTok Shop product by its URL, including stock levels and affiliate videos. Returns product_info with product_base (title, images, sold_count, price), skus (variants with exact stock counts plus TikTok's sku_name and gtin when available), and product_detail_review (product_rating, review_count, sample reviews). gtin contains gtin_type and gtin_code, or is null when TikTok does not provide a barcode. The response also includes shop_info (shop_name, shop_rating, followers_count) and related_videos (affiliate TikToks promoting the pr
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the product to get details for. | |
| region | No | Region for the product details request. US is the reliable region right now; non-US regions should not be considered reliable and may return `bad_request` or missing product data. Sorry for the inconvenience. |
scrapecreators_get_v1_tiktok_profileTikTok — ProfileInspect
Fetches public profile data for a TikTok user by their handle or user_id — useful for looking up a creator's identity, bio, and account stats. Returns a user object (display name, avatar URLs, bio/signature, verification status, bio link) and a stats object (followerCount, followingCount, heartCount/total likes, videoCount). This only returns profile metadata, not the user's actual videos or followers list.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | No | TikTok handle. You can pass handle or user_id. | |
| user_id | No | TikTok user id. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_tiktok_profile_regionTikTok — Profile RegionInspect
Returns the TikTok region code for a public profile, like US for United States or MX for Mexico.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | TikTok handle |
scrapecreators_get_v1_tiktok_search_hashtagTikTok — Search by HashtagInspect
Searches for TikTok videos under a specific hashtag — useful for finding content by topic or trend. Returns aweme_list, an array of video objects each with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and author details. Paginate with cursor from the previous response. TikTok may return duplicate results.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response | |
| cursor | No | Cursor to get more videos. Get 'cursor' from previous response. | |
| region | No | Region the proxy will be set to. Note: this isn't going to grab you all tiktoks from this region, you're just setting the proxy there. | |
| hashtag | Yes | Hashtag to search for (without #) |
scrapecreators_get_v1_tiktok_search_keywordTikTok — Search by KeywordInspect
Searches for TikTok videos by keyword or phrase — the general video search across all of TikTok. Returns search_item_list, an array of objects each containing aweme_info with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and author details. Paginate with cursor. TikTok may return duplicate results.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response | |
| query | Yes | Keyword to search for | |
| cursor | No | Cursor to get more videos. Get 'cursor' from previous response. | |
| region | No | Note, this doesn't filter the tiktoks only in a specfic region, it puts the proxy there. Use it in case you want to scrape posts only available for some country. Use 2 letter country codes like US, GB, FR, etc | |
| sort_by | No | Sort by | |
| date_posted | No | Time Frame |
scrapecreators_get_v1_tiktok_search_suggestionsTikTok — Search SuggestionsInspect
Gets the autocomplete suggestions TikTok shows while someone is typing in search. Returns suggestions, a clean array of suggested search terms and the most useful metadata for each suggestion.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query to get suggestions for | |
| region | No | Region code for suggestions |
scrapecreators_get_v1_tiktok_search_topTikTok — Top SearchInspect
Searches TikTok's 'Top' results by query — returns both videos and photo carousels, unlike keyword search which only returns videos. Returns items, an array of objects each with id, desc (caption), content_type (video or photo carousel), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and images for carousels. Paginate with cursor. TikTok may return duplicate results.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Keyword to search for | |
| cursor | No | Cursor to get more videos. Get 'cursor' from previous response. | |
| region | No | Note, this doesn't filter the tiktoks only in a specfic region, it puts the proxy there. Use it in case you want to scrape posts only available for some country. Use 2 letter country codes like US, GB, FR, etc | |
| sort_by | No | Sort by | |
| publish_time | No | Time Frame TikTok was posted |
scrapecreators_get_v1_tiktok_search_usersTikTok — Search UsersInspect
Searches for TikTok users by keyword or name — useful for finding creators or accounts matching a query. Returns users, an array of objects each containing user_info (nickname, unique_id, signature/bio, follower_count, following_count, avatar) and associated items. Paginate with cursor from the previous response.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response | |
| query | Yes | Search query for users | |
| cursor | No | Cursor to get more users. Get 'cursor' from previous response. |
scrapecreators_get_v1_tiktok_shop_product_reviewsTikTok Shop — Product ReviewsInspect
Fetches customer reviews for a TikTok Shop product by URL or product_id. Returns product_reviews, an array of review objects each with rating, display_text, review_timestamp_fmt, review_user (name, avatar), and sku_specification (variant purchased); also returns total_reviews count and rating_distribution. Paginate with page.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The URL of the product (required if product_id is not provided) | |
| page | No | The page number of the reviews | |
| region | No | The region of the product. US is the reliable region right now; non-US regions should not be considered reliable and may return limited or inconsistent review data. Sorry for the inconvenience. | |
| product_id | No | The ID of the product (required if url is not provided) |
scrapecreators_get_v1_tiktok_shop_productsTikTok Shop — Shop ProductsInspect
Lists all products from a specific TikTok Shop store by its URL. Returns an array of product objects each with title, cover images, url, price info, sold_count, review_count, and rating. Paginate with cursor from the previous response; filter by region; use sort_by=top for best-selling products or sort_by=new_releases for newest products. Non-US shop catalog coverage depends on TikTok exposing that shop in the selected region, so some shops can return not_found outside the US even when they appear in shop search.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The TikTok Shop store URL. | |
| cursor | No | Cursor parameter from the previous response to retrieve the next page of products. Omit for the first page. | |
| region | No | Region to get shop products from. Defaults to US if not provided. Non-US regions are not reliable right now and may return `not_found` or limited catalog data even when the shop appears in search. Sorry for the inconvenience. | |
| sort_by | No | Sort products by best-selling items (`top`) or newest products (`new_releases`). Defaults to `top`. |
scrapecreators_get_v1_tiktok_shop_searchTikTok Shop — Shop SearchInspect
Searches TikTok Shop for products matching a keyword query. Returns an array of product objects each with title, cover image, url (product page link), price, sold_count, review_count, rating, and shop_name. Paginate with page; filter by region.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number to retrieve | |
| query | Yes | Term you want to search for | |
| region | No | Region to search shop products in. Non-US TikTok Shop regions are not reliable right now and may return limited or inconsistent results. Sorry for the inconvenience. |
scrapecreators_get_v1_tiktok_songTikTok — Get Song DetailsInspect
Fetches detailed metadata for a specific TikTok sound or song by its clipId. Returns music_info with title, author, album, duration, user_count (number of videos using this sound), play_url, cover art, and artist details. Use the clipId from a sound URL or from the popular songs endpoint.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| clipId | Yes | This is a little confusing because this isn't songId like you'd think. It is the clipId. I guess because you can clip different portions of a song 🤷♂️ |
scrapecreators_get_v1_tiktok_song_videosTikTok — TikToks using SongInspect
Fetches TikTok videos that use a specific sound or song, identified by its clipId. Returns aweme_list, an array of video objects each with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and author details. Paginate with cursor from the previous response.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| clipId | No | This is clipId. Can be found on a url like so: https://www.tiktok.com/music/That%27s-Who-I-Praise-7370375686554782506, where 7370375686554782506 is the clipId | |
| cursor | No | The cursor to get the next page of results. |
scrapecreators_get_v1_tiktok_user_audienceTikTok — User's Audience DemographicsInspect
Retrieves audience demographic data for a TikTok user, showing where their followers are located by country. Returns audienceLocations, an array of objects each containing country, countryCode, count, and percentage. Costs 26 credits per request.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | TikTok handle |
scrapecreators_get_v1_tiktok_user_followersTikTok — FollowersInspect
Retrieves the follower list of a TikTok account by handle or user_id — useful for seeing who follows a creator or getting subscriber data. Returns followers, an array of user objects each with nickname, unique_id, uid, follower_count, following_count, and avatar URLs; also returns total follower count. Paginate with min_time from the previous response.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response | |
| handle | No | TikTok handle | |
| user_id | No | User id. Use this for faster response times. | |
| min_time | No | Used to paginate. Get 'min_time' from previous response. |
scrapecreators_get_v1_tiktok_user_followingTikTok — FollowingInspect
Retrieves the following list — accounts that a TikTok user follows — by their handle. Returns followings, an array of user objects each with nickname, unique_id, uid, follower_count, following_count, signature, and avatar URLs; also returns total count. Paginate with min_time from the previous response.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response | |
| handle | Yes | TikTok handle | |
| min_time | No | Used to paginate. Get 'min_time' from previous response. |
scrapecreators_get_v1_tiktok_user_liveTikTok — LiveInspect
Checks if a TikTok user is currently live streaming and retrieves their live room details. Use the top-level is_live boolean instead of checking TikTok's numeric status values yourself. Also returns liveRoomUserInfo (nickname, avatar, followerCount, roomId) and liveRoom (title, startTime, status, liveRoomStats with enterCount and userCount, plus streamData with playback URLs in multiple qualities).
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | TikTok handle |
scrapecreators_get_v1_tiktok_user_showcaseTikTok Shop — User ShowcaseInspect
Fetches products featured in a TikTok user's public showcase — the products a creator promotes on their profile. Returns an array of product objects each with title, price, images, and shop details. Use POST request if pagination is cutting off too early. Just send the query params in the body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | The cursor to the next page of products | |
| handle | Yes | The handle of the user | |
| region | No | Region to put the proxy in. Non-US TikTok Shop regions are not reliable right now and may return limited or inconsistent showcase data. Sorry for the inconvenience. |
scrapecreators_get_v1_tiktok_video_comment_repliesTikTok — Comment RepliesInspect
Fetches replies to a specific TikTok comment by its ID. Returns comments, an array of comment objects each with text, user info, and create_time. Paginate with cursor from the previous response.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | TikTok video URL. This is the url from the comments endpoint. | |
| cursor | No | Cursor to get more replies. Get 'cursor' from previous response. | |
| comment_id | Yes | TikTok comment ID. This is the cid from the comments endpoint. |
scrapecreators_get_v1_tiktok_video_commentsTikTok — CommentsInspect
Fetches comments on a TikTok video by URL — useful for reading audience reactions, replies, and engagement. Returns comments, an array where each comment includes text, digg_count (likes), reply_comment_total, create_time, and a user object with the commenter's nickname and unique_id; also returns total comment count. Paginate with cursor from the previous response. Public photo/slideshow posts are supported as well as videos. Comments use a separate TikTok public web source, so successful single-post metadata retrieval does not guarantee readable comments. An empty terminal pa
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | TikTok video URL | |
| trim | No | Set to true to get a trimmed response | |
| cursor | No | Cursor to get more comments. Get 'cursor' from previous response. |
scrapecreators_get_v1_truthsocial_postTruth Social Post DetailsInspect
Fetches a single Truth Social post by URL, returning text, id, created_at, url, content, account details, media_attachments, card link previews, replies_count, reblogs_count, and favourites_count. Set download_media=true to download attached images or video and return permanent Supabase URLs. Only posts from prominent public figures (e.g., Trump, Vance) are accessible without authentication. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Truth Social post URL | |
| download_media | No | Set to true to download the attached video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise. |
scrapecreators_get_v1_truthsocial_profileTruth Social — ProfileInspect
Retrieves a Truth Social user's public profile including display_name, username, avatar, header, followers_count, following_count, statuses_count, verified status, website, and created_at. Only prominent public figures (e.g., Trump, Vance) are accessible without authentication; most other accounts will not work. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Truth Social username |
scrapecreators_get_v1_truthsocial_user_postsTruth Social — User PostsInspect
Fetches a paginated list of posts from a Truth Social user, returning text, id, created_at, url, content, account info, media_attachments, card link previews, replies_count, reblogs_count, and favourites_count. Supports pagination via next_max_id and a trim option for lighter responses. Only prominent public figures (e.g., Trump, Vance) are accessible without authentication. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| handle | No | Truth Social username | |
| user_id | No | Truth Social user id. Use this for faster response times. Trumps is 107780257626128497. It is the 'id' field in the profile endpoint. | |
| next_max_id | No | Used to paginate to next page |
scrapecreators_get_v1_twitch_clipTwitch — ClipInspect
Fetches detailed data for a Twitch clip by URL, including metadata and direct video URLs. Returns clip id, slug, url, embedURL, title, viewCount, language, durationSeconds, game info, broadcaster details with follower count, thumbnailURL, and videoQualities at multiple resolutions with a signed videoURL for playback. Also includes additional clips from the same broadcaster. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Twitch clip URL | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_twitch_clip_transcriptTwitch Clip TranscriptInspect
Gets a transcript from a public Twitch clip. Checks native captions first; returned native captions cost 1 credit. Set use_ai_as_fallback=true to opt into paid AI only when captions are unavailable. No transcript costs 0 credits. transcript_source is native, ai, or null. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 cr Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Twitch clip URL | |
| use_ai_as_fallback | No | Use paid AI only when native captions are unavailable. Defaults to false. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. | |
| allow_long_transcription | No | Paid opt-in, enabled only by the literal query value 'true' (allow_long_transcription=true). Defaults to false when omitted; other values do not enable paid mode. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get_transcript=true or use_ai_as_fallback=true where required by the endpoint. Returned native captions still cost 1 credit on dedicated transcript routes, even for long videos with this flag; on detail routes they leave the base price unchanged. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. |
scrapecreators_get_v1_twitch_profileTwitch — ProfileInspect
Retrieves a Twitch user's public profile by handle, including identity, social links, and content. Returns id, handle, displayName, description, followers count, and linked social accounts (instagram, x, tiktok). Also includes lastBroadcast with startedAt (ISO 8601 UTC) and title, allVideos with game info, duration, and view counts, featuredClips with clip metadata and thumbnails, and similarStreamers. lastBroadcast comes from Twitch's broadcast metadata rather than saved videos, so it can remain available when a channel is offline and its saved broadcasts have expired or were never saved. las Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Twitch handle | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_twitch_user_scheduleTwitch — User ScheduleInspect
Fetches a user's schedule by handle, returning a list of scheduled events with start time, end time, title, description, and thumbnail URL. Supports pagination via cursor and a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Twitch handle |
scrapecreators_get_v1_twitch_user_videosTwitch — User VideosInspect
Fetches a list of videos (100 max) for a Twitch user, returning each video's id, slug, url, embedURL, title, viewCount, language, durationSeconds, game info, broadcaster details with follower count, thumbnailURL, and videoQualities at multiple resolutions with a signed videoURL for playback. Supports pagination via cursor and a trim option for lighter responses. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Twitch handle | |
| sort_by | No | Sort by | |
| filter_by | No | Filter by |
scrapecreators_get_v1_twitter_communityTwitter — CommunityInspect
Retrieves details about a Twitter/X Community by URL. Returns the community name, description, rest_id, join_policy, created_at, member_count, rules, and creator_results with the creator's profile. Also includes members_facepile_results with avatar images of recent members. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Community URL |
scrapecreators_get_v1_twitter_community_tweetsTwitter — Community TweetsInspect
Fetches tweets posted within a Twitter/X Community by URL. Returns an array of tweets, each with id, full_text, view_count, favorite_count, retweet_count, reply_count, bookmark_count, quote_count, created_at, and source. Each tweet includes a user object with the author's name, screen_name, avatar, followers_count, and is_blue_verified status. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Community URL |
scrapecreators_get_v1_twitter_profileTwitter — ProfileInspect
Retrieves a Twitter user's profile by handle, including account metadata and statistics. Returns name, screen_name, description, followers_count, friends_count, statuses_count, favourites_count, location, profile_image_url_https, and is_blue_verified. Also includes verification_info, tipjar_settings, highlights_info, and creator_subscriptions_count. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | Yes | Twitter handle | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_twitter_search_postsTwitter — Search PostsInspect
Finds public X/Twitter post URLs through Google Search, then returns their details using the same public post scraper as /v1/twitter/tweet. This is Google-indexed discovery, not native X search: coverage is incomplete, recent posts can be missing, and results are ranked by Google rather than newest first. Deleted, protected, or inaccessible posts are omitted. Each post uses the existing tweet response fields, including rest_id, legacy.full_text, legacy.created_at, engagement counts, author and media when available, plus a canonical url. Pass the returned cursor for the next Google page; cursor Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Keyword or phrase to search for in Google-indexed public X/Twitter posts | |
| cursor | No | Pass the cursor returned by the previous response. Supported page cursors are 1 through 11. A null response cursor means there are no more pages. |
scrapecreators_get_v1_twitter_tweetTwitter — Tweet DetailsInspect
Retrieves detailed information about a specific tweet by URL, including the author's profile and engagement metrics. Returns rest_id, full_text, views count, favorite_count, retweet_count, reply_count, bookmark_count, quote_count, created_at, source, and media entities. Supports a trim parameter for a lighter response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Tweet URL | |
| trim | No | Set to true for a trimmed down version of the response | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_twitter_user_tweetsTwitter — User TweetsInspect
Fetches tweets from a Twitter user's profile by handle. Note: Twitter publicly returns only ~100 of the user's most popular tweets, not chronological or latest. Each tweet includes rest_id, full_text, views count, favorite_count, retweet_count, reply_count, bookmark_count, quote_count, created_at, media entities, and url. Supports a trim parameter for a lighter response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| handle | Yes | Twitter handle |
scrapecreators_get_v1_youtube_channelYouTube — Channel DetailsInspect
Retrieves comprehensive YouTube channel profile data including name, avatar images, subscriber count (subscribers), total video and view counts, join date, tags, and linked social accounts like Twitter and Instagram. Accepts a channelId, handle, or full channel URL as input. Returns channel metadata such as country, email, and external store links when available. Contact fields come from the submitted public profile. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | YouTube channel URL. Can pass a channelId, handle or url | |
| handle | No | YouTube channel handle. Can pass a channelId, handle or url | |
| channelId | No | YouTube channel ID. Can pass a channelId, handle or url | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_youtube_channel_community_postsYouTube — Channel Community PostsInspect
Fetches community posts from a YouTube channel's Posts tab, including post ID, URL, content, images, attached video, like count, publish time, channel info, and a continuationToken when YouTube has more results. Pass a handle or channelId for the first page, then pass continuationToken to page through more posts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | No | YouTube channel handle | |
| channelId | No | YouTube channel ID | |
| continuationToken | No | Continuation token to get more community posts. Get 'continuationToken' from previous response. |
scrapecreators_get_v1_youtube_channel_livesYouTube — Channel LivesInspect
Fetches live streams and past streams from a YouTube channel's Live tab, including title, URL, thumbnail, view count, publish time, duration, and a continuationToken when YouTube has more results. Pass a handle or channelId for the first page, then pass continuationToken to page through more lives. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | No | YouTube channel handle | |
| channelId | No | YouTube channel ID | |
| continuationToken | No | Continuation token to get more lives. Get 'continuationToken' from previous response. |
scrapecreators_get_v1_youtube_channel_playlistsYouTube — Channel PlaylistsInspect
Fetches playlists from a YouTube channel's Playlists tab, including playlist ID, title, thumbnail, video count, channel info, playlist URL, and a continuationToken when YouTube has more results. Pass a handle or channelId for the first page, then pass continuationToken to page through more playlists. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| handle | No | YouTube channel handle | |
| channelId | No | YouTube channel ID | |
| continuationToken | No | Continuation token to get more playlists. Get 'continuationToken' from previous response. |
scrapecreators_get_v1_youtube_channel_searchYouTube Channel SearchInspect
Search within one YouTube channel using YouTube's native channel search, not global search or local filtering of the channel's latest videos. Pass a handle with or without @ and a keyword query. Results can include videos, Shorts, live streams and playlists in separate collections. Keep the same handle and query when passing the previous response's continuationToken. Stop when continuationToken is null; passing the literal continuationToken=null returns an uncharged terminal response. Each successful page costs 1 credit, including pages with no matches; invalid requests and retrieval failures Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Keywords to search within this channel. | |
| handle | Yes | YouTube channel handle, with or without @. | |
| continuationToken | No | Token from the previous response. Keep the same handle and query; stop when the token is null. |
scrapecreators_get_v1_youtube_channel_shortsYouTube — Channel ShortsInspect
Retrieves a paginated list of short-form videos (Shorts) from a YouTube channel, including each short's title, URL, view count (views), likes, comments, description, and publish date. publishDate is a full ISO 8601 timestamp with an offset when YouTube exposes the exact publish time; otherwise it is null. It does not return date-only strings. Supports sorting by newest or popular; use the continuationToken to page through all results. Returns data in the shorts array. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort by newest or popular | |
| handle | No | Can pass channelId or handle | |
| channelId | No | Can pass channelId or handle | |
| continuationToken | No | Continuation token to get more videos. Get 'continuationToken' from previous response. |
scrapecreators_get_v1_youtube_channel_videosYouTube — Channel VideosInspect
Fetches a paginated list of videos uploaded by a YouTube channel, including each video's title, URL, thumbnail, view count (views), publish date, duration, and description. Supports sorting by latest or popular, and use the continuationToken to page through all results. Optionally include extras like like count, comment count, and descriptions for each video. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort by latest or popular | |
| handle | No | YouTube channel handle | |
| channelId | No | YouTube channel ID | |
| includeExtras | No | This will get you the like + comment count and the description. To get the full details of the video, use the /v1/youtube/video endpoint. Honestly, if you use this param, the error rate is higher. We might deprecate this param in the future. | |
| continuationToken | No | Continuation token to get more videos. Get 'continuationToken' from previous response. | |
| is_paid_promotions | No | Set to 'true' to search YouTube's public paid product placement / sponsorship / endorsement search surface. This returns normal YouTube videos where the creator declared paid promotion. Cannot be combined with filter, uploadDate, sortBy, type, duration, or includeExtras. |
scrapecreators_get_v1_youtube_community_postYouTube — Community Post DetailsInspect
Retrieves the full details of a YouTube community post, including its text content, attached images, like count, publish date, and associated channel info. Also returns a linked video if the post includes one. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the YouTube community post to get |
scrapecreators_get_v1_youtube_playlistYouTube — PlaylistInspect
Retrieves a page of videos in a YouTube playlist, including each video's title, URL, thumbnail, duration, and channel. Accepts the playlist ID found in the 'list' URL parameter. The first page includes title, owner, and totalVideos. Later pages return videos and continuationToken without playlist metadata. Pass the previous response's continuationToken to get the next page. Stop when continuationToken is null. Each page costs 1 credit. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| playlist_id | Yes | The ID of the YouTube playlist. In the YouTube URL it will be the 'list' parameter. | |
| continuationToken | No | Token from the previous response to get the next page. Omit for the first page. Stop when the returned continuationToken is null. |
scrapecreators_get_v1_youtube_searchYouTube — SearchInspect
Searches YouTube by keyword query and returns matching videos, channels, playlists, shorts, shelves, and live streams. Each video result includes title, URL, thumbnail, view count (views), publish date, duration, channel info, and badges. Supports filtering by upload date, sorting by relevance or popularity, and paginating with continuationToken. Set is_paid_promotions=true to search YouTube videos with the paid product placement / sponsorship disclosure. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Type of content to search for | |
| query | Yes | Search query. For stricter title matching, use YouTube's intitle: operator, for example intitle:"Foursquare Swarm". Quoted queries by themselves may still be broadened by YouTube when no fresh exact matches are available. | |
| region | No | 2 letter country code of the country to put the proxy in. | |
| sortBy | No | Sort by | |
| duration | No | Duration of the video. Only applies to videos (not shorts). | |
| uploadDate | No | Upload date | |
| includeExtras | No | This will get you the like + comment count and the description. To get the full details of the video, use the /v1/youtube/video endpoint. *This will slow down the response slightly.* | |
| continuationToken | No | Continuation token to get more videos. Get 'continuationToken' from previous response. |
scrapecreators_get_v1_youtube_search_hashtagYouTube — Search by HashtagInspect
Searches YouTube for content matching a specific hashtag and returns matching videos with title, URL, thumbnail, view count (views), publish date, duration, and channel info. Supports pagination via continuationToken and filtering to return all content types or only shorts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Search for all types of content or only shorts | |
| hashtag | Yes | Hashtag to search for | |
| continuationToken | No | Continuation token to get more videos. Get 'continuationToken' from previous response. |
scrapecreators_get_v1_youtube_search_typeaheadYouTube — Search TypeaheadInspect
Returns the live search suggestions YouTube displays while a user types. Each result includes the suggested text and whether it is a normal query or a channel. When YouTube returns a channel suggestion, the response also includes its public channel ID, handle, name, and thumbnail. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Partial or complete YouTube search query |
scrapecreators_get_v1_youtube_shorts_trendingYouTube — Trending ShortsInspect
Fetches approximately 48 currently trending YouTube Shorts (viral/popular short-form videos) per call, returning each short's title, URL, thumbnail, view count (views), like count (likes), comment count, publish date, channel info, keywords, and duration. Each subsequent call returns a fresh batch of different trending shorts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
scrapecreators_get_v1_youtube_videoYouTube — Video/Short DetailsInspect
Fetches full details for a YouTube video or short, including title, description, thumbnail, view count (views), like count (likes), comment count, publish date, duration, genre, keywords, chapters, collaborators, and available caption tracks (subtitles/captions). isPaidPromotion is true when YouTube marks the video as including paid promotion and false when it does not. Also returns related recommended videos in watchNextVideos and channel info for the uploader. When YouTube exposes its public Most replayed graph, most_replayed contains normalized graph buckets in markers and YouTube's highlig Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | YouTube video or short URL | |
| language | No | Preferred response language (mapped to Accept-Language header; not guaranteed due to YouTube localization behavior). 2 letter language code, ie 'en', 'es', 'fr' etc. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) |
scrapecreators_get_v1_youtube_video_comment_repliesYouTube — Comment RepliesInspect
Fetches replies to a specific comment on a YouTube video, including each reply's text content, author details (name, channel ID, avatar, verified/creator status), like count, and publish date. Requires a continuationToken obtained from the 'repliesContinuationToken' field on comments returned by the Comments endpoint. Supports paginating through additional replies with the continuationToken returned in each response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| continuationToken | Yes | Continuation token for the comment replies. Use 'repliesContinuationToken' from the Comments endpoint, or 'continuationToken' from a previous replies response to paginate. |
scrapecreators_get_v1_youtube_video_commentsYouTube — CommentsInspect
Fetches comments and replies from a YouTube video, including each comment's text content, author details, like count, reply count, and publish date. Supports ordering by top or newest, and paginating with continuationToken. Limited to approximately 1,000 top comments or 7,000 newest comments. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | YouTube video URL | |
| order | No | Order of comments | |
| continuationToken | No | Continuation token to get more comments. Get 'continuationToken' from previous response. |
scrapecreators_get_v1_youtube_video_sponsorsYouTube — Video SponsorsInspect
Experimental endpoint. Checks a YouTube video for the paid-promotion disclosure and infers likely sponsors/promoted brands from the public description, description links, promo-code text, and transcript. YouTube tells us that a video contains paid promotion, but it does not always tell us the sponsor directly, so this endpoint returns suspected sponsors with confidence and evidence. This is inferred, not an official YouTube sponsor field. Feedback welcome: support@scrapecreators.com Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | YouTube video or short URL | |
| language | No | 2 letter language code used for transcript lookup, ie 'en', 'es', 'fr' etc. |
scrapecreators_get_v1_youtube_video_transcriptYouTube — TranscriptInspect
Retrieves publicly available captions, subtitles, or transcripts from a YouTube video or Short. Returns both a timestamped transcript array with start/end times and a plain-text version in transcript_only_text. Supports specifying a language code. Videos of any length are supported when YouTube exposes public captions. This endpoint does not use AI transcription. A returned transcript costs 1 credit; missing captions cost 0 credits. If no matching caption track is available, the transcript fields return null. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | YouTube video or short URL | |
| language | No | Language code, ie 'en', 'es', 'fr' or 'en-US'. Overrides the default track selection unless original_audio=true. If omitted, prefers captions matching the original spoken language when YouTube identifies the original audio. If that metadata is unavailable or ambiguous, prefers an auto-generated caption, otherwise the first caption track. If the requested or identified original language has no matching captions, the transcript will be null and no credits are charged. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) | |
| original_audio | No | Set to true to return captions only in the original spoken language identified by YouTube. Takes precedence over language. If the original audio cannot be reliably identified or has no matching captions, transcript, transcript_only_text, and language are null and no credits are charged. No extra lookup or credit cost; a returned transcript costs the usual 1 credit. Omit or set to false for the existing default selection. |
scrapecreators_get_v2_instagram_post_commentsInstagram Post CommentsInspect
Retrieves comments on a public Instagram post or reel. Each comment includes the comment text, creation timestamp, reply count when Instagram provides it, and commenter details such as username, user ID, verification status, and profile picture URL. child_comment_count can be null when Instagram does not expose the count publicly. Set include_replies=true to fetch the first page of replies for every returned comment. This adds replies, replies_cursor, and has_more_replies to each comment. Successful pages with comments: [] cost 0 credits, even with include_replies=true. Pages wit
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the post or reel to get comments from | |
| cursor | No | The cursor to get more comments. Get 'cursor' from previous response. | |
| include_replies | No | Set to true to include replies for every returned comment. Costs 15 credits when comments are returned, even if no replies are found; successful pages with no comments cost 0 credits. This is much slower and may time out at 29 seconds. |
scrapecreators_get_v2_instagram_reels_searchInstagram — Search ReelsInspect
Use this when you only want Google-indexed Instagram reels matching a keyword or phrase, with optional date filters and pagination. It returns reel media, engagement, owner, location, and audio details. Results are best-effort rather than a complete Instagram-native search. For Instagram-curated topic posts, use /v1/instagram/search/popular. For an exact hashtag across posts and reels, use /v1/instagram/search/hashtag. Pages 1 through 11 are supported; page 12 or greater returns a 400 response. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number to return. Must be between 1 and 11; page 12 or greater returns a 400 response. | |
| query | Yes | The keyword to search for | |
| date_posted | No | Google-indexed date window. Recent hour/day filters are not supported because Google does not index Instagram reels reliably enough in those windows. |
scrapecreators_get_v2_instagram_user_postsInstagram — PostsInspect
Returns a paginated feed of a user's public Instagram posts, including reels, photos, videos, and carousels. Each item includes media type, shortcode, caption text, like count, comment count, play count, video URLs, image URLs, tagged users, and the published time in items[].created_at as an ISO 8601 UTC date. When supplied by Instagram, the media-level fbid is also returned. The original Unix timestamp remains available in items[].taken_at. Play counts reflect Instagram-only views and exclude cross-posted Facebook views. Supports cursor-based pagination via next_max_id for scrolling thr
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true to get a trimmed response | |
| handle | Yes | Instagram handle | |
| next_max_id | No | Cursor to get next page of results. |
scrapecreators_get_v2_tiktok_videoTikTok Video DetailsInspect
Fetches detailed data for a single TikTok video by URL, including its metadata, engagement stats, and optionally its transcript/captions. Returns aweme_detail with desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count, collect_count), video URLs, author info, and music info; also returns transcript in WEBVTT format if get_transcript=true. For no-watermark video URLs, use aweme_detail.video.download_no_watermark_addr.url_list[0] when it exists. If it is missing and aweme_detail.video.has_watermark is false, use `aweme_detail.video.play_addr.url
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | TikTok video or photo/slideshow URL | |
| trim | No | Set to true to get a trimmed response | |
| region | No | Two-letter country code passed to the primary post source. Defaults to US. Try the creator's country if a post is unavailable. This does not guarantee a matching browser/proxy country or complete retrieval; the fallback source does not receive this parameter. | |
| cache_max_age | No | If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.](https://docs.scrapecreators.com/caching) | |
| download_media | No | Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise. | |
| get_transcript | No | Native captions are opt-in via get_transcript=true and are included in the existing base endpoint price. This detail endpoint does not use AI transcription or an AI fallback; missing captions return no transcript. For AI fallback, use /v1/tiktok/video/transcript. |
scrapecreators_get_v3_tiktok_profile_videosTikTok — Profile VideosInspect
Fetches videos posted by a TikTok user, sortable by latest or most popular — use this to get a creator's video feed or TikToks. Returns aweme_list, an array of video objects each containing aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count, collect_count/saves), and video (download URLs, duration, cover image). Paginate with max_cursor from the previous response, keeping the same region and sort_by throughout a cursor chain. Known limitation: this feed is not an exhaustive inventory of a creator's public posts. TikTok's web page, sin
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| handle | Yes | TikTok handle | |
| region | No | Country code passed to the profile-feed source. Defaults to US. If a profile should have videos but returns none, try another relevant two-letter country code. Changing this value does not guarantee that region-restricted posts will appear. | |
| sort_by | No | What to sort by | |
| user_id | No | TikTok user id. Use this for faster responses. | |
| max_cursor | No | Cursor to get more videos. Get 'max_cursor' from previous response. | |
| include_pinned | No | Whether to include pinned posts. Defaults to true. Set to false to exclude posts marked as pinned, including with trim=true. Keep this value unchanged while paginating. Filtering can produce shorter or empty pages; follow has_more and max_cursor. Successful pages still cost 1 credit, including empty results. |
scrapecreators_post_v1_facebook_adlibrary_company_adsFacebook Ad Library — Company AdsInspect
Fetches all ads currently running for a specific company from the Meta Ad Library. Each ad includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body, images, videos, and display_format. Supports filtering by country, media_type, date range, and language with cursor-based pagination. Both GET and POST are supported. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| cursor | No | Cursor to paginate through results | |
| pageId | No | The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName | |
| status | No | Status of the ad. Defaults to ACTIVE. | |
| country | No | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. | |
| sort_by | No | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. | |
| end_date | No | End date to search for. Format: YYYY-MM-DD | |
| language | No | Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc | |
| media_type | No | Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme. | |
| start_date | No | Start date to search for. Format: YYYY-MM-DD | |
| companyName | No | The name of the company. Can either use this or pageId |
scrapecreators_post_v1_facebook_adlibrary_search_adsFacebook Ad Library — SearchInspect
Searches the Meta Ad Library by keyword and returns matching ads. Supports filtering by language with a 2-letter code such as EN or ES. Each result includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body text, images, videos, and cta_text. Both GET and POST are supported. Use GET for normal requests. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | No | Set to true for a trimmed down version of the response | |
| query | Yes | Keyword to search for | |
| cursor | No | Cursor to paginate through results | |
| status | No | Status of the ad. Defaults to ACTIVE. | |
| ad_type | No | Search for all ads or only political and issue ads | |
| country | No | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. | |
| sort_by | No | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. | |
| end_date | No | Impressions end date. Needs to be in YYYY-MM-DD format. | |
| language | No | Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR. | |
| media_type | No | Media type of the ad. Defaults to ALL. Meme just means the ad has text and an image. No clue why they call it meme. | |
| start_date | No | Impressions start date. Needs to be in YYYY-MM-DD format. | |
| search_type | No | If you want to search by exact phrase or not |
scrapecreators_post_v1_reddit_post_commentsReddit — Post CommentsInspect
Retrieves comments and post details from a Reddit post by URL. Returns the post with title, author, score, ups, upvote_ratio, num_comments, and created_utc, plus a comments array where each comment includes author, body, body_html, score, created_utc, parent_id, permalink, and nested replies. Both GET and POST are supported. Use GET for normal requests. Pass one opaque cursor exactly as returned by more.cursor or replies.more.cursor to load the next page. Cursor batching and comma-separated cursor values are not supported. If an opaque cursor becomes too large after extensive pagination, use P Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Reddit post URL | |
| trim | No | Set to true for a trimmed down version of the response | |
| cursor | No | One opaque cursor returned by the previous response to get more comments or replies. Do not combine multiple cursors. |
search1api_get_deepcrawl_status_taskidCheck deepcrawl task statusInspect
Poll a deepcrawl task started by POST /deepcrawl. Returns the task's current state and, once it finishes, where to retrieve the packaged result. Safe to call repeatedly. Free to call. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| taskId | Yes |
search1api_get_usageGet API key usage statisticsInspect
Get API key usage statistics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No |
search1api_post_askSearch the engines a natural-language request calls forInspect
Agentic search. Describe what you are looking for in plain language and let a decision model (currently TypeSafe Jev) decide where to look. It picks up to five engines (web search, Hacker News, Reddit, GitHub, X, arXiv, Wikipedia, IMDb, WeChat, YouTube), rewrites the request into search keywords, infers a publication window from phrases such as "this week", searches the engines in parallel, and returns only the results judged relevant, merged and ranked, so agents read fewer off-topic results. The request takes only query; engines, keywords, and the window are always chosen by the model, and
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | What you are looking for, in natural language. Platform hints ("on Reddit", "papers") and time hints ("this week") steer engine and time-range selection. |
search1api_post_extractExtract structured content from a URLInspect
Pull structured data out of a single webpage using a natural-language prompt and a JSON schema you supply. Use it when you need specific fields — prices, specifications, contact details — rather than the whole document; when you want the full text, use POST /crawl. Costs 10 credits per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| prompt | No | ||
| response_format | No |
search1api_post_feedbackReport a Search1API problem or feature requestInspect
Report a Search1API problem, missing capability, or confusing documentation encountered during a task. Only message is required. Optional request_id refers to the original problem request. Do not include credentials, personal data, or private user content. Reports are stored in Agentback and linked to an opaque account reference. Do not report every empty result or retry the same report automatically; feedback should not block the main task. Returns 201 only after storage succeeds. Maximum JSON body size: 16 KiB. Limited to 10 submissions per account per minute at a Cloudflare location. Free t Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| agent | No | ||
| intent | No | ||
| message | Yes | ||
| category | No | ||
| request_id | No |
search1api_post_mapsSearch Google Maps for local businesses and placesInspect
Discover businesses and places with names, place IDs and public Maps links, plus addresses, contact details, ratings, review counts, coordinates and opening hours when available. Optional result fields are omitted when unavailable. Use POST /search for webpages and POST /crawl to read a business website. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, 1–6; default 1. Accepts an integer or canonical integer string such as "2". Empty strings use the default. Pages after the first require location. | |
| query | Yes | Google Maps search phrase; leading and trailing whitespace is removed. | |
| country | No | Two-letter country code, normalized to lowercase. Defaults to us. | |
| language | No | Result language, for example en, de or zh-CN. Defaults to en. | |
| location | No | Search origin coordinates and map zoom (default 14). Required for page > 1. Latitude must be -90 to 90, longitude -180 to 180, and zoom 3 to 30. Example: {"latitude":40.7455,"longitude":-74.0083,"zoom":15}. | |
| max_results | No | Maximum places to return from this page, 1–20; default 20. Accepts an integer or canonical integer string such as "10". Empty strings use the default. Truncation does not reduce the page charge or carry places to the next page. |
search1api_post_sitemapExtract sitemap URLs from a websiteInspect
Discover the public URLs of a site when you need to know which pages exist before fetching any of them — scoping a crawl, auditing coverage, or locating a section. With the default type: "sitemap" this reads the site's own sitemap: Sitemap: directives in robots.txt first, then the conventional paths, following sitemap index files and gzipped sitemaps, and returns the URLs it declares for the requested host. A site that publishes no sitemap falls back to the links found on the given page. Use type: "all" to skip the sitemap and get every link on that one page instead, including links to o
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| type | No |
search1api_post_trendingGet trending topics from various platformsInspect
List what is currently popular on a supported platform, such as GitHub repositories or Hacker News stories, when the user asks what is trending or new right now. This reads a platform's own live ranking rather than performing a query — for topic searches use POST /search. Costs 1 credit per request. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| max_results | No | ||
| search_service | Yes |
serper_postSerper WebpageInspect
Extract text from a public web page, optionally including Markdown; charges are variable. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public image URL for Lens, or public page URL for Webpage. This is an input URL, not a Serper execution origin. | |
| includeMarkdown | No | Whether the Webpage extractor should include Markdown. |
serper_post_autocompleteSerper AutocompleteInspect
Get query completion suggestions; this endpoint returns suggestions rather than web pages. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. |
serper_post_lensSerper LensInspect
Reverse-search a publicly accessible image URL with Google Lens. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| url | Yes | Public image URL for Lens, or public page URL for Webpage. This is an input URL, not a Serper execution origin. |
serper_post_mapsSerper MapsInspect
Find rich Google Maps places by text, viewport, Place ID or CID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Text query for this search. Supply a non-empty query for keyword search modes. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| ll | No | Maps GPS position and zoom. Official UI placeholder: @latitude,longitude,zoom. | |
| cid | No | Google CID. Keep all digits in a string; do not convert to a floating-point number. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. | |
| placeId | No | Google Place ID. Reviews requires a usable place identifier; Maps can also search by identifier. |
serper_post_newsSerper NewsInspect
Find news articles with source links and publication information. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| tbs | No | Date range selector: empty=any time; qdr:h/hour, qdr:d/day, qdr:w/week, qdr:m/month, qdr:y/year. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. |
serper_post_patentsSerper PatentsInspect
Find patents with publication identifiers, dates, assignees and document links. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| num | No | Result count. Images offers 10 or 100 with different prices; Shopping/Patents emit 40 in official generated code. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. |
serper_post_placesSerper PlacesInspect
Find businesses by text query and optional named location; retain business identifiers as strings. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. | |
| location | No | Optional canonical location chosen in the Places location selector; not a free-form GPS viewport. |
serper_post_reviewsSerper ReviewsInspect
Read and paginate Google place reviews by CID, FID or Place ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| cid | No | Google CID. Keep all digits in a string; do not convert to a floating-point number. | |
| fid | No | Google feature identifier for the place reviewed. Keep it as a string. | |
| sortBy | No | Review ordering chosen from the official dropdown. | |
| placeId | No | Google Place ID. Reviews requires a usable place identifier; Maps can also search by identifier. | |
| topicId | No | Optional review topic identifier. | |
| nextPageToken | No | Opaque review pagination cursor from the preceding response; keep unchanged and stop when absent. |
serper_post_scholarSerper ScholarInspect
Find scholarly publications, publication metadata and observed citation counts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. |
serper_post_searchSerper SearchInspect
Search Google and read organic results, knowledge panels, related questions and searches. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| tbs | No | Date range selector: empty=any time; qdr:h/hour, qdr:d/day, qdr:w/week, qdr:m/month, qdr:y/year. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. |
serper_post_shoppingSerper ShoppingInspect
Find Google Shopping listings; product prices in results are separate from API call charges. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| num | No | Result count. Images offers 10 or 100 with different prices; Shopping/Patents emit 40 in official generated code. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. |
serper_post_videosSerper VideosInspect
Find videos with titles, destination URLs, channels, duration and publication information. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Text query for this search. Supply a non-empty query for keyword search modes. | |
| gl | No | Country code from the official selector. The UI initially selects us; server default is not verified. | |
| hl | No | Language code from the official selector. The UI initially selects en; server default is not verified. | |
| tbs | No | Date range selector: empty=any time; qdr:h/hour, qdr:d/day, qdr:w/week, qdr:m/month, qdr:y/year. | |
| page | No | Results page. UI starts at 1; each page is a separate single-query request. Server bounds are not published here. |
sourcify_get_server_chainsSourcify — Get the list of supported and deprecated chainsInspect
Get the list of supported and deprecated chains Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
sourcify_get_server_v2_contract_chainid_addressSourcify — Get verified contractInspect
By default returns minimal information about the contract: match, creationMatch, runtimeMatch, chainId, address, and verifiedAt.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| omit | No | Comma seperated fields to NOT include in the response. All fields except matching ones will be returned. Can't be used simultanously with `fields`. A short `omit` list returns almost every field, so it costs almost as much as `fields=all`. Do not use `omit` in loops. Use `fields` to request only what you need. | |
| fields | No | Comma-separated list of fields to include in the response. Can also be `all` to return every available field. See the endpoint description for the full list of available fields. `all` includes all source files and the full standard JSON input and output, so it is expensive. Do not use `all` in loops. Request only the fields that you need. | |
| address | Yes | Contract's 20 byte address in hex string with the 0x prefix. Case insensitive. | |
| chainId | Yes | The chainId number of the EVM chain |
sourcify_get_server_v2_contracts_chainidSourcify — List of verified contracts per chainInspect
Retrieve the verified contracts on a chain Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sorts the contracts by most recent first (`desc`, default), or by oldest first (`asc`) | |
| limit | No | Number of contracts that should be returned per page. Maximum 200 | |
| chainId | Yes | The chainId number of the EVM chain | |
| afterMatchId | No | The last `matchId` returned to get contracts older or newer than it (depending on `sort`) |
sourcify_get_signature_database_v1_lookupSourcify — Lookup signaturesInspect
Look up one or more function or event signatures by hash. This API maintains compatibility with openchain.xyz behavior - functions return null for no matches, events return empty arrays. Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| event | No | A comma-delimited list of event hashes with leading 0x prefix. Must be exactly 66 characters (0x + 64 hex chars). | |
| filter | No | Whether or not to filter out junk results | |
| function | No | A comma-delimited list of function or error hashes with leading 0x prefix. Must be exactly 10 characters (0x + 8 hex chars). Since the original openchain.xyz API didn't support error signatures, we treat error signatures as function signatures. They are both 4 byte hashes. |
sourcify_get_signature_database_v1_recentSourcify — List recently added signaturesInspect
Lists the signatures that were added to the database at or after since, oldest first. Each signature has its types and, if a verified contract uses it, one such contract as source. The source is the contract whose verification added the signature, if possible. An imported signature that no verified contract uses has the source null.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit | |
| since | No | ISO 8601 time. At most one day ago. The default is one hour ago. | |
| cursor | No | The `next` value of the previous page |
sourcify_get_signature_database_v1_searchSourcify — Search signaturesInspect
Search signatures by name (case sensitive) with wildcards, limited to the first 100 unordered results Documentation prepared only; runtime not verified. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The name of the function to search for. Case sensitive. Use '*' and '?' for wildcards. | |
| filter | No | Whether or not to filter out junk results |
sourcify_get_signature_database_v1_statsSourcify — Show database statsInspect
function, event and error show the number of signatures that are associated with a verified contract and the respective type. A signature can have more than one type. unknown shows the number of signatures that are not associated with a verified contract, hence no type can be assigned. total shows the total number of signatures in the database. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tavily_post_crawlInitiate a web crawl from a base URLInspect
Tavily Crawl is a graph-based website traversal tool that can explore hundreds of paths in parallel with built-in extraction and intelligent discovery. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The root URL to begin the crawl. | |
| limit | No | Total number of links the crawler will process before stopping. | |
| format | No | The format of the extracted web page content. `markdown` returns content in markdown format. `text` returns plain text and may increase latency. | |
| max_depth | No | Max depth of the crawl. Defines how far from the base URL the crawler can explore. | |
| max_breadth | No | Max number of links to follow per level of the tree (i.e., per page). | |
| instructions | No | Natural language instructions for the crawler. When specified, the mapping cost increases to 2 API credits per 10 successful pages instead of 1 API credit per 10 pages. | |
| select_paths | No | Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`). | |
| exclude_paths | No | Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`). | |
| extract_depth | No | Advanced extraction retrieves more data, including tables and embedded content, with higher success but may increase latency. `basic` extraction costs 1 credit per 5 successful extractions, while `advanced` extraction costs 2 credits per 5 successful extractions. | |
| allow_external | No | Whether to include external domain links in the final results list. | |
| include_images | No | Whether to include images in the crawl results. | |
| select_domains | No | Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\.example\.com$`). | |
| exclude_domains | No | Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\.example\.com$`). | |
| include_favicon | No | Whether to include the favicon URL for each result. | |
| chunks_per_source | No | Chunks are short content snippets (about 800 characters each) pulled directly from the source. Use `chunks_per_source` to define the maximum number of relevant chunks returned per source and to control the `raw_content` length. Chunks will appear in the `raw_content` field as: `<chunk 1> [...] <chunk 2> [...] <chunk 3>`. If a page splits into no more chunks than `chunks_per_source`, its full content is returned. Available only when `instructions` are provided. Must be between 1 and 5. |
tavily_post_extractTavily Keyless ExtractInspect
Extract content from one URL or batch up to 20 URLs in one request. Successful URLs appear in results; per-URL failures appear in failed_results. Check both arrays even when the response is HTTP 200. Request options apply to every URL in the batch. Set include_usage=true in the request body; billing uses response usage.credits at USD 0.008 per credit. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Extract content from one URL or batch up to 20 URLs in one request. Successful URLs appear in results; per-URL failures appear in failed_results. Check both arrays even when the response is HTTP 200. Request options apply to every URL in the batch. |
tavily_post_mapInitiate a web mapping from a base URLInspect
Tavily Map traverses websites like a graph and can explore hundreds of paths in parallel with intelligent discovery to generate comprehensive site maps. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The root URL to begin the mapping. | |
| limit | No | Total number of links the crawler will process before stopping. | |
| max_depth | No | Max depth of the mapping. Defines how far from the base URL the crawler can explore. | |
| max_breadth | No | Max number of links to follow per level of the tree (i.e., per page). | |
| instructions | No | Natural language instructions for the crawler. When specified, the cost increases to 2 API credits per 10 successful pages instead of 1 API credit per 10 pages. | |
| select_paths | No | Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`). | |
| exclude_paths | No | Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`). | |
| allow_external | No | Whether to include external domain links in the final results list. | |
| select_domains | No | Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\.example\.com$`). | |
| exclude_domains | No | Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\.example\.com$`). |
tavily_post_searchTavily Keyless SearchInspect
Execute a search query using Tavily Search. Set include_usage=true in the request body; billing uses response usage.credits at USD 0.008 per credit. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Execute a search query using Tavily Search. |
tikhub_get_api_v1_bilibili_app_fetch_bangumi_tabGet bangumi tabInspect
Get bangumi tab Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_app_fetch_cinema_tabGet cinema tabInspect
Get cinema tab Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_app_fetch_home_feedGet home feedInspect
Get home feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| idx | No | 页面索引/Page index | |
| pull | No | 是否下拉刷新/Pull to refresh | |
| flush | No | 刷新标记/Flush flag (0=普通加载, 1=刷新) |
tikhub_get_api_v1_bilibili_app_fetch_one_videoGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| av_id | No | AV号/AV ID | |
| bv_id | No | BV号/BV ID |
tikhub_get_api_v1_bilibili_app_fetch_popular_feedGet popular feedInspect
Get popular feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| idx | No | 页面索引/Page index | |
| last_param | No | 上一页最后一个视频ID/Last video ID |
tikhub_get_api_v1_bilibili_app_fetch_reply_detailGet reply detailInspect
Get reply detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ps | No | 每页数量/Page size | |
| root | Yes | 一级评论ID/Root comment ID | |
| av_id | No | AV号/AV ID | |
| bv_id | No | BV号/BV ID | |
| next_offset | No | 下一页游标/Next page cursor |
tikhub_get_api_v1_bilibili_app_fetch_search_allsearch allInspect
search all Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order | No | 排序方式/Sort order (0=综合排序) | |
| cursor | No | 翻页游标,首页留空;翻页时传回上一页响应的 data.pagination.next/Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response | |
| keyword | Yes | 搜索关键词/Search keyword | |
| page_size | No | 每页数量/Page size |
tikhub_get_api_v1_bilibili_app_fetch_search_by_typesearch by typeInspect
search by type Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order | No | 排序方式/Sort order (0=综合, 1=最新, 2=播放量, 3=弹幕数) | |
| cursor | No | 翻页游标,首页留空;翻页时传回上一页响应的 data.pagination.next/Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response | |
| keyword | Yes | 搜索关键词/Search keyword | |
| page_size | No | 每页数量/Page size | |
| search_type | No | 搜索类型/Search type (video/bangumi/pgc/live/article/user) |
tikhub_get_api_v1_bilibili_app_fetch_user_infoGet user infoInspect
Get user info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_bilibili_app_fetch_user_videosGet user videosInspect
Get user videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ps | No | 每页数量/Page size | |
| page | No | 页码/Page number | |
| user_id | Yes | 用户ID/User ID | |
| post_filter | No | 过滤类型/Filter type (archive/season/contribute) |
tikhub_get_api_v1_bilibili_app_fetch_video_commentsGet video commentsInspect
Get video comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | 排序模式/Sort mode (3=热门/hot, 2=时间/time) | |
| av_id | No | AV号/AV ID | |
| bv_id | No | BV号/BV ID | |
| next_offset | No | 分页游标/Pagination cursor |
tikhub_get_api_v1_bilibili_huahuo_account_session_infoGet current advertiser account informationInspect
Get current advertiser account information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_cooperate_experience_industryGet collaboration-experience industriesInspect
Get collaboration-experience industries Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| industry_type | Yes | 行业序号:1=游戏 2=日化/小家电 3=数码家电 4=汽车 5=食饮 6=网服 |
tikhub_get_api_v1_bilibili_huahuo_dmp_pkg_listGet audience packagesInspect
Get audience packages Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_effect_goods_dropGet commerce category optionsInspect
Get commerce category options Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_industry_tagsGet industry tagsInspect
Get industry tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_label_char_styleGet content-style tagsInspect
Get content-style tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_live_area_listGet live-streaming areasInspect
Get live-streaming areas Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_live_commerce_infoGet live-commerce performanceInspect
Get live-commerce performance Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| upper_mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_live_good_categoryGet live-commerce categoriesInspect
Get live-commerce categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_live_guild_dropGet live-streaming guildsInspect
Get live-streaming guilds Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | 按名称模糊过滤,空=全部 |
tikhub_get_api_v1_bilibili_huahuo_live_parent_tagGet live creator persona tagsInspect
Get live creator persona tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_live_upper_portraitGet live creator profileInspect
Get live creator profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mcn_id | Yes | MCN机构ID,可从广场搜索结果或 upper_base_info 取得 | |
| upper_mid | No | UP主UID,可选 |
tikhub_get_api_v1_bilibili_huahuo_mcn_dropGet MCN organizationsInspect
Get MCN organizations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | 按名称模糊过滤,空=全部 |
tikhub_get_api_v1_bilibili_huahuo_partition_dropGet video partition optionsInspect
Get video partition options Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_popular_avid_category_dropGet video ranking industriesInspect
Get video ranking industries Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_popular_avid_listGet Huahuo video rankingsInspect
Get Huahuo video rankings Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| category | No | 行业名,取值见 popular_avid_category_drop,空=全部 |
tikhub_get_api_v1_bilibili_huahuo_popular_goods_industry_up_listGet commerce creators by industryInspect
Get commerce creators by industry Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| x_huo_industry_id | Yes | 行业ID,取值见 x_huo_industry_drop?scene=2 |
tikhub_get_api_v1_bilibili_huahuo_popular_goods_listGet X-Huo product rankingsInspect
Get X-Huo product rankings Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| rank_type | No | 榜单口径 | |
| data_cycle | No | 数据周期 | |
| max_goods_price | No | 商品价格上限 | |
| min_goods_price | No | 商品价格下限 | |
| x_huo_industry_id | Yes | 行业ID,取值见 x_huo_industry_drop?scene=2 |
tikhub_get_api_v1_bilibili_huahuo_popular_goods_up_listGet creators ranked for a productInspect
Get creators ranked for a product Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| goods_id | Yes | 商品ID,取值见 popular_goods_list |
tikhub_get_api_v1_bilibili_huahuo_popular_up_listGet creator rankingsInspect
Get creator rankings Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| tid_name | No | 榜单分区名,取值见 popular_up_tid_drop,空=全部 | |
| rank_cate | No | 榜单类型:1=成长黑马榜 2=超值优选榜 3=头部必选榜 |
tikhub_get_api_v1_bilibili_huahuo_popular_up_tid_dropGet creator ranking categoriesInspect
Get creator ranking categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_popular_up_x_huoGet X-Huo creator rankingsInspect
Get X-Huo creator rankings Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| rank_date | No | 榜单期数 `YYYY-MM`,取值见 x_huo_date_options;留空取最新一期 | |
| rank_date_type | No | 榜单周期:1=月度榜 2=季度榜 | |
| x_huo_industry_id | Yes | 行业ID,取值见 x_huo_industry_drop |
tikhub_get_api_v1_bilibili_huahuo_region_dropGet region optionsInspect
Get region options Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_search_upper_suggestSearch creator suggestionsInspect
Search creator suggestions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,从 1 开始 / One-based page number | |
| cpm_type | No | CPM 流量口径:1=全部流量,2=自然流量 / CPM traffic scope: 1=all, 2=organic | |
| cpm_cycle | No | CPM 统计周期:1=7天,2=15天,3=30天 / CPM window: 1=7, 2=15, 3=30 days | |
| panel_type | No | 行业策略面板,取值同 search_upper / Industry strategy panel; values match search_upper | |
| marketing_target | No | 营销目标,取值同 search_upper / Marketing objective; values match search_upper | |
| nickname_or_mids | Yes | 昵称片段或 UP 主 UID / Creator nickname fragment or UID | |
| play_median_cycle | No | 播放中位数周期:1=7天,2=15天,3=30天 / Median-view window: 1=7, 2=15, 3=30 days | |
| play_median_traffic_type | No | 播放中位数流量口径:1=全部流量,2=自然流量 / Median-view traffic scope: 1=all, 2=organic |
tikhub_get_api_v1_bilibili_huahuo_square_static_infoGet creator marketplace filter dictionariesInspect
Get creator marketplace filter dictionaries Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_tag_characterGet persona tagsInspect
Get persona tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_tag_commercialGet commercial tagsInspect
Get commercial tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_tag_occupationGet occupation tagsInspect
Get occupation tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_huahuo_upper_archive_highlightsGet creator video highlightsInspect
Get creator video highlights Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| day_range | No | 统计周期:1=近30天 2=近90天 3=近180天 | |
| upper_mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_upper_base_infoGet creator basic informationInspect
Get creator basic information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_upper_busy_timeGet creator unavailable datesInspect
Get creator unavailable dates Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_upper_by_nicknameFind creators by nicknameInspect
Find creators by nickname Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| nickname | Yes | UP主昵称 |
tikhub_get_api_v1_bilibili_huahuo_upper_detailGet creator profileInspect
Get creator profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| upper_mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_upper_draft_performanceGet creator video performanceInspect
Get creator video performance Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| day_range | No | 统计周期:1=近30天 2=近90天 3=近180天 | |
| upper_mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_upper_draft_trendGet creator video metric trendsInspect
Get creator video metric trends Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| upper_mid | Yes | UP主UID | |
| trend_type | No | 指标:3=播放量 4=点赞量 5=评论量 6=弹幕量 7=播放时长 |
tikhub_get_api_v1_bilibili_huahuo_upper_fans_trendGet creator follower trendsInspect
Get creator follower trends Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| upper_mid | Yes | UP主UID | |
| query_type | No | 口径:1=总量 2=增量 |
tikhub_get_api_v1_bilibili_huahuo_upper_label_treeGet creator filter panel configurationInspect
Get creator filter panel configuration Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| panel_type | No | 行业策略面板:0=通用,1=游戏,2=美妆,3=数码,4=汽车,5=效果,6=食饮,8=网服 / Strategy panel: 0=general, 1=gaming, 2=beauty, 3=digital, 4=automotive, 5=performance, 6=food, 8=internet |
tikhub_get_api_v1_bilibili_huahuo_upper_overlap_uppersGet creators with overlapping audiencesInspect
Get creators with overlapping audiences Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| upper_mid | Yes | UP主UID | |
| fans_range | No | 粉丝量级档位:9=200万以上 8=100~200万 7=50~100万 6=30~50万 5=20~30万 4=10~20万 3=5~10万 2=1~5万 |
tikhub_get_api_v1_bilibili_huahuo_upper_representativeGet creator representative videosInspect
Get creator representative videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | 作品类型:1=个人作品 2=商业作品 | |
| upper_mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_upper_seek_infoGet creator inquiry settingsInspect
Get creator inquiry settings Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_upper_similarGet creators with similar contentInspect
Get creators with similar content Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| upper_mid | Yes | UP主UID |
tikhub_get_api_v1_bilibili_huahuo_x_huo_date_optionsGet X-Huo ranking periodsInspect
Get X-Huo ranking periods Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| rank_date_type | No | 榜单周期:1=月度榜 2=季度榜 |
tikhub_get_api_v1_bilibili_huahuo_x_huo_industry_dropGet X-Huo ranking industriesInspect
Get X-Huo ranking industries Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| scene | No | 场景:1=UP主榜 2=商品榜 |
tikhub_get_api_v1_bilibili_web_bv_to_aidGenerate aid by bvidInspect
Generate aid by bvid Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bv_id | Yes | 作品id/Video id |
tikhub_get_api_v1_bilibili_web_fetch_all_live_areasGet a list of all live areasInspect
Get a list of all live areas Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_bilibili_web_fetch_collect_foldersGet user collection foldersInspect
Get user collection folders Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户UID |
tikhub_get_api_v1_bilibili_web_fetch_comment_replyGet reply to the specified commentInspect
Get reply to the specified comment Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pn | No | 页码/Page number | |
| rpid | Yes | 回复id/Reply id | |
| bv_id | Yes | 作品id/Video id |
tikhub_get_api_v1_bilibili_web_fetch_com_popularGet comprehensive popular video informationInspect
Get comprehensive popular video information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pn | No | 页码/Page number |
tikhub_get_api_v1_bilibili_web_fetch_dynamic_detailGet dynamic detailInspect
Get dynamic detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dynamic_id | Yes | 动态id/Dynamic id |
tikhub_get_api_v1_bilibili_web_fetch_dynamic_detail_v2Get dynamic detail v2Inspect
Get dynamic detail v2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dynamic_id | Yes | 动态id/Dynamic id |
tikhub_get_api_v1_bilibili_web_fetch_general_searchGet general search dataInspect
Get general search data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | 页码/Page number | |
| order | Yes | 排序方式/Order method | |
| keyword | Yes | 搜索关键词/Search keyword | |
| duration | No | 时长筛选/Duration filter | |
| page_size | Yes | 每页数量/Number per page | |
| pubtime_end_s | No | 结束日期/End date (10-digit timestamp) | |
| pubtime_begin_s | No | 开始日期/Start date (10-digit timestamp) |
tikhub_get_api_v1_bilibili_web_fetch_get_user_idExtract user IDInspect
Extract user ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| share_link | Yes | 用户分享链接/User share link |
tikhub_get_api_v1_bilibili_web_fetch_live_room_detailGet information of specified live roomInspect
Get information of specified live room Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间ID/Live room ID |
tikhub_get_api_v1_bilibili_web_fetch_live_streamersGet live streamers of specified live areaInspect
Get live streamers of specified live area Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pn | No | 页码/Page number | |
| area_id | Yes | 直播分区id/Live area ID |
tikhub_get_api_v1_bilibili_web_fetch_live_videosGet live video data of specified roomInspect
Get live video data of specified room Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间ID/Live room ID |
tikhub_get_api_v1_bilibili_web_fetch_one_videoGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bv_id | Yes | 作品id/Video id |
tikhub_get_api_v1_bilibili_web_fetch_one_video_v2Get single video data V2Inspect
Get single video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| a_id | Yes | 作品id/Video id | |
| c_id | Yes | 作品cid/Video cid |
tikhub_get_api_v1_bilibili_web_fetch_one_video_v3Get single video data V3Inspect
test Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes |
tikhub_get_api_v1_bilibili_web_fetch_user_collection_videosGets video data from a collection folderInspect
Gets video data from a collection folder Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pn | No | 页码/Page number | |
| folder_id | Yes | 收藏夹id/collection folder id |
tikhub_get_api_v1_bilibili_web_fetch_user_dynamicGet dynamic information of specified userInspect
Get dynamic information of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户UID | |
| offset | No | 开始索引/offset |
tikhub_get_api_v1_bilibili_web_fetch_user_post_videosGet user homepage video dataInspect
Get user homepage video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pn | No | 页码,最大100/Page number, max 100 | |
| ps | No | 每页数量,最大50/Page size, max 50 | |
| uid | Yes | 用户UID | |
| order | No | 排序方式/Order method |
tikhub_get_api_v1_bilibili_web_fetch_user_post_videos_v2Get user homepage video data V2Inspect
Get user homepage video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pn | No | 页码,无上限/Page number, no cap | |
| ps | No | 每页数量,最大100/Page size, max 100 | |
| uid | Yes | 用户UID | |
| keyword | No | 关键词,留空返回全部/Keyword, empty returns all |
tikhub_get_api_v1_bilibili_web_fetch_user_profileGet information of specified userInspect
Get information of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户UID |
tikhub_get_api_v1_bilibili_web_fetch_user_relation_statGet user relation stat (following and followers)Inspect
Get user relation stat (following and followers) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户UID/User UID |
tikhub_get_api_v1_bilibili_web_fetch_user_up_statGet UP stat (total views and likes)Inspect
Get UP stat (total views and likes) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户UID/User UID |
tikhub_get_api_v1_bilibili_web_fetch_video_commentsGet comments on the specified videoInspect
Get comments on the specified video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pn | No | 页码/Page number | |
| bv_id | Yes | 作品id/Video id |
tikhub_get_api_v1_bilibili_web_fetch_video_danmakuGet Video DanmakuInspect
Get Video Danmaku Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cid | Yes | 作品cid/Video cid |
tikhub_get_api_v1_bilibili_web_fetch_video_detailGet single video detailInspect
Get single video detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aid | Yes | 作品id/Video id |
tikhub_get_api_v1_bilibili_web_fetch_video_partsGet Video Parts By bvidInspect
Get Video Parts By bvid Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| bv_id | Yes | 作品id/Video id |
tikhub_get_api_v1_bilibili_web_fetch_video_play_infoGet single video play infoInspect
Get single video play info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 视频链接/Video URL |
tikhub_get_api_v1_bilibili_web_fetch_video_playurlGet video playurlInspect
Get video playurl Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cid | Yes | 作品cid/Video cid | |
| bv_id | Yes | 作品id/Video id |
tikhub_get_api_v1_bilibili_web_fetch_video_subtitleGet video subtitle infoInspect
Get video subtitle info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| a_id | Yes | 作品id/Video id | |
| c_id | Yes | 作品cid/Video cid |
tikhub_get_api_v1_douyin_app_v3_fetch_brand_hot_search_listGet Douyin brand hot search list dataInspect
Get Douyin brand hot search list data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_app_v3_fetch_brand_hot_search_list_detaGet Douyin brand hot search list detail dataInspect
Get Douyin brand hot search list detail data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| category_id | Yes | 分类id/Category id |
tikhub_get_api_v1_douyin_app_v3_fetch_hashtag_detailGet details of specified hashtagInspect
Get details of specified hashtag Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ch_id | Yes | 话题id/Hashtag id |
tikhub_get_api_v1_douyin_app_v3_fetch_hashtag_video_listGet video list of specified hashtagInspect
Get video list of specified hashtag Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ch_id | Yes | 话题id/Hashtag id | |
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| sort_type | No | 排序类型/Sort type |
tikhub_get_api_v1_douyin_app_v3_fetch_hot_search_listGet Douyin hot search list dataInspect
Get Douyin hot search list data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| board_type | No | 榜单类型/Board type | |
| board_sub_type | No | 榜单子类型/Board sub type |
tikhub_get_api_v1_douyin_app_v3_fetch_live_hot_search_listGet Douyin live hot search list dataInspect
Get Douyin live hot search list data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_app_v3_fetch_multi_video_statisticsGet the statistical data of the Post according to the video ID (like count, download count, play count, share count)Inspect
Get the statistical data of the Post according to the video ID (like count, download count, play count, share count) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_ids | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_app_v3_fetch_music_detailGet details of specified musicInspect
Get details of specified music Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| music_id | Yes | 音乐id/Music id |
tikhub_get_api_v1_douyin_app_v3_fetch_music_hot_search_listGet Douyin music hot search list dataInspect
Get Douyin music hot search list data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| chart_type | No | 榜单类型/Chart type |
tikhub_get_api_v1_douyin_app_v3_fetch_music_video_listGet video list of specified musicInspect
Get video list of specified music Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| music_id | Yes | 音乐id/Music id |
tikhub_get_api_v1_douyin_app_v3_fetch_one_videoGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_app_v3_fetch_one_video_v2Get single video data V2Inspect
Get single video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_app_v3_fetch_one_video_v3Get single video data V3 (No copyright restrictions)Inspect
Get single video data V3 (No copyright restrictions) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品或文章ID/Video or Article ID |
tikhub_get_api_v1_douyin_app_v3_fetch_series_detailGet series detailInspect
Get series detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| series_id | Yes | 短剧id/Series id |
tikhub_get_api_v1_douyin_app_v3_fetch_series_video_listGet series video listInspect
Get series video list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| series_id | Yes | 短剧id/Series id |
tikhub_get_api_v1_douyin_app_v3_fetch_user_fans_listGet user fans listInspect
Get user fans list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| max_time | No | 最大时间戳/Maximum timestamp | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_douyin_app_v3_fetch_user_like_videosGet user like video dataInspect
Get user like video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| counts | No | 每页数量/Number per page | |
| max_cursor | No | 最大游标/Maximum cursor | |
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_douyin_app_v3_fetch_user_post_videosGet user homepage video dataInspect
Get user homepage video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| channel | No | 抖音渠道版本/Douyin channel: normal(正常版-默认), lite(极速版) | |
| sort_type | No | 排序类型/Sort type | |
| max_cursor | No | 最大游标/Maximum cursor | |
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_douyin_app_v3_fetch_user_series_listGet user series listInspect
Get user series list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| user_id | No | 用户id/User id | |
| sec_user_id | No | 用户加密id/User sec id |
tikhub_get_api_v1_douyin_app_v3_fetch_video_comment_repliesGet comment replies data of specified videoInspect
Get comment replies data of specified video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| item_id | Yes | 作品id/Video id | |
| comment_id | Yes | 评论id/Comment id |
tikhub_get_api_v1_douyin_app_v3_fetch_video_commentsGet single video comments dataInspect
Get single video comments data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_app_v3_fetch_video_high_quality_play_urGet the highest quality play URL of the videoInspect
Get the highest quality play URL of the video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 可选,请求出口地区(ISO 国家代码,如 CN/US/HK),国内用户传 CN 可拿到国内 CDN 域名以加快下载速度 / Optional, ISO country code (e.g. CN/US/HK). Pass CN to get China-region CDN URLs for faster download in mainland China. | |
| aweme_id | No | 作品id/Video id | |
| share_url | No | 可选,分享链接/Optional, share link |
tikhub_get_api_v1_douyin_app_v3_fetch_video_mix_detailGet Douyin video mix detail dataInspect
Get Douyin video mix detail data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mix_id | Yes | 合集id/Mix id |
tikhub_get_api_v1_douyin_app_v3_fetch_video_mix_post_listGet Douyin video mix post list dataInspect
Get Douyin video mix post list data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| mix_id | Yes | 合集id/Mix id |
tikhub_get_api_v1_douyin_app_v3_fetch_video_statisticsGet the statistical data of the Post according to the video ID (like count, download count, play count, share count)Inspect
Get the statistical data of the Post according to the video ID (like count, download count, play count, share count) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_ids | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_app_v3_generate_douyin_short_urlGenerate Douyin short linkInspect
Generate Douyin short link Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 抖音链接/Douyin link |
tikhub_get_api_v1_douyin_app_v3_handler_user_profileGet information of specified userInspect
Get information of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_keyword_searcGenerate Douyin share link, call Douyin APP, and jump to the specified keyword search resultInspect
Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 关键词/Keyword |
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_send_privateGenerate Douyin share link, call Douyin APP, and send private messages to specified usersInspect
Generate Douyin share link, call Douyin APP, and send private messages to specified users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户id/User id | |
| sec_uid | Yes | 用户sec_uid/User sec_uid |
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_user_profileGenerate Douyin share link, call Douyin APP, and jump to the specified user profileInspect
Generate Douyin share link, call Douyin APP, and jump to the specified user profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户id/User id | |
| sec_uid | Yes | 用户sec_uid/User sec_uid |
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_video_detailGenerate Douyin share link, call Douyin APP, and jump to the specified video details pageInspect
Generate Douyin share link, call Douyin APP, and jump to the specified video details page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_app_v3_register_deviceDouyin APP register deviceInspect
Douyin APP register device Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 代理/Proxy |
tikhub_get_api_v1_douyin_billboard_fetch_city_listFetch Chinese city listInspect
Fetch Chinese city list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_billboard_fetch_content_tagFetch vertical content tagsInspect
Fetch vertical content tags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_inte_2Fetch fan interest search term in the last 3 days 10 search termsInspect
Fetch fan interest search term in the last 3 days 10 search terms Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_uid | Yes | 用户sec_id |
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_inte_3Fetch fan interest author 20 usersInspect
Fetch fan interest author 20 users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_uid | Yes | 用户sec_id |
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_intereFetch fan interest topic in the last 3 days 10 topicsInspect
Fetch fan interest topic in the last 3 days 10 topics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_uid | Yes | 用户sec_id |
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_portraFetch fan portraitInspect
Fetch fan portrait Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| option | No | 选项,1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布 8 兴趣标签分析 百分比 | |
| sec_uid | Yes | 用户sec_id |
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_item_analysFetch account work analysis - last weekInspect
Fetch account work analysis - last week Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_uid | Yes | 用户sec_id |
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_search_listFetch account search listInspect
Fetch account search list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | Yes | 游标,默认空 | |
| keyword | Yes | 搜索的用户名或抖音号 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_trends_listFetch account fan data trendInspect
Fetch account fan data trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| option | No | 选项,2 新增点赞量 3 新增作品量 4 新增评论量 5 新增分享量 | |
| sec_uid | Yes | 用户sec_id | |
| date_window | No | 数据点粒度(小时),可选 1/24,代表每小时一个点/每天一个点,默认24 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_calendar_detailFetch activity calendar detailInspect
Fetch activity calendar detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| calendar_id | Yes | 活动id |
tikhub_get_api_v1_douyin_billboard_fetch_hot_category_listFetch hot list categoryInspect
Fetch hot list category Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 热点搜索词 | |
| end_date | No | 快照结束时间 格式yyyyMMdd | |
| start_date | No | 快照开始时间 格式yyyyMMdd | |
| snapshot_time | No | 快照时间 格式yyyyMMddHHmmss | |
| billboard_type | Yes | 榜单类型 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_challenge_listFetch hot challenge listInspect
Fetch hot challenge list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | 页码 | |
| keyword | No | 热点搜索词 | |
| page_size | Yes | 每页数量 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_city_listFetch city hot listInspect
Fetch city hot list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | 页码 | |
| order | Yes | 排序方式 | |
| keyword | No | 热点搜索词 | |
| city_code | No | 城市编码,从城市列表获取,空为全部 | |
| page_size | Yes | 每页数量 | |
| sentence_tag | No | 热点分类标签,从热点榜分类获取,多个分类用逗号分隔,空为全部 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_comment_word_listFetch work comment analysis word cloud weightInspect
Fetch work comment analysis word cloud weight Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id |
tikhub_get_api_v1_douyin_billboard_fetch_hot_item_trends_listFetch post data trendInspect
Fetch post data trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| option | No | 选项,7 点赞量 8 分享量 9 评论量 | |
| aweme_id | No | 作品id | |
| date_window | No | 数据点粒度,可选 1/2,代表按小时/按天,默认1 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_rise_listFetch rising hot listInspect
Fetch rising hot list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | 页码 | |
| order | Yes | 排序方式 | |
| keyword | No | 热点搜索词 | |
| page_size | Yes | 每页数量 | |
| sentence_tag | No | 热点分类标签,从热点榜分类获取,多个分类用逗号分隔,空为全部 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_total_hot_word_detaFetch content word detailsInspect
Fetch content word details Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键字 | |
| word_id | Yes | 内容词id | |
| query_day | Yes | 查询日期,格式为YYYYMMDD,需为当日 |
tikhub_get_api_v1_douyin_billboard_fetch_hot_total_listFetch total hot listInspect
Fetch total hot list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | 页码 | |
| type | Yes | 快照类型 snapshot 按时刻查看 range 按时间范围 | |
| keyword | No | 热点搜索词 | |
| end_date | No | 快照结束时间 格式yyyyMMdd | |
| page_size | Yes | 每页数量 | |
| start_date | No | 快照开始时间 格式yyyyMMdd | |
| sentence_tag | No | 热点分类标签,从热点榜分类获取,多个分类用逗号分隔,空为全部 | |
| snapshot_time | No | 快照时间 格式yyyyMMddHHmmss |
tikhub_get_api_v1_douyin_billboard_fetch_hot_user_portrait_listFetch work like audience portrait - hot list onlyInspect
Fetch work like audience portrait - hot list only Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| option | No | 选项,1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布 | |
| aweme_id | Yes | 作品id |
tikhub_get_api_v1_douyin_creator_fetch_creator_activity_detailGet creator activity detailInspect
Get creator activity detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| activity_id | Yes | 活动ID/Activity ID |
tikhub_get_api_v1_douyin_creator_fetch_creator_activity_listGet creator activity listInspect
Get creator activity list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_time | Yes | 结束时间戳/End timestamp | |
| start_time | Yes | 开始时间戳/Start timestamp |
tikhub_get_api_v1_douyin_creator_fetch_creator_content_categoryGet creator content creation categoryInspect
Get creator content creation category Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_creator_fetch_creator_content_courseGet creator content creation courseInspect
Get creator content creation course Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页数量/Items per page | |
| order | No | 排序方式/Order type (1=推荐排序, 2=最受欢迎, 3=最新上传) | |
| offset | No | 偏移量/Offset (starting position) | |
| category_id | Yes | 分类ID/Category ID |
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_challenge_bilGet creator hot challenge billboardInspect
Get creator hot challenge billboard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_courseGet creator hot courseInspect
Get creator hot course Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页数量/Items per page (建议24) | |
| order | No | 排序方式/Order type (1=推荐排序, 2=最受欢迎, 3=最新上传) | |
| offset | No | 偏移量/Offset | |
| category_id | No | 精选专题分类ID/Selected topic category ID - 不传则为热门课程,传入则为精选专题 可选值/Available values: 6976547830546582816=知识品类, 6976547923849006336=生活品类, 6976547940311633165=娱乐品类, 6976547972108635404=美食品类, 6980288134957272352=正能量, 6980288181744766219=游戏品类, 6980288219548011776=通用 |
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_music_billboaGet creator hot music billboardInspect
Get creator hot music billboard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order_key | No | 排序键/Order key (1=播放最高, 2=点赞最多, 4=热度最高, 5=投稿最多) | |
| time_filter | No | 时间筛选/Time filter (1=24小时, 2=7天, 3=30天) | |
| billboard_tag | No | 榜单标签/Billboard tag (0=全部,具体分类值可通过配置接口获取) |
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_props_billboaGet creator hot props billboardInspect
Get creator hot props billboard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order_key | No | 排序键: 1=播放最高, 5=投稿最多, 6=展现最高, 7=收藏最高/Order key: 1=highest views, 5=most submissions, 6=highest exposure, 7=most favorites | |
| time_filter | No | 时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days | |
| billboard_tag | No | 榜单标签,0=全部,其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface |
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_spot_billboarGet creator hot spot billboardInspect
Get creator hot spot billboard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| city_code | No | 城市代码,当hot_search_type=2时必需/City code - required when hot_search_type=2 | |
| billboard_tag | No | 热点标签,多个标签用逗号分隔,如'1004,1000,1002'/Hot spot tag - multiple tags separated by comma, like '1004,1000,1002' | |
| hot_search_type | No | 热搜类型: 1=热点总榜, 2=同城热点榜, 3=热点上升榜/Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking |
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_topic_billboaGet creator hot topic billboardInspect
Get creator hot topic billboard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order_key | No | 排序键: 1=播放最高, 2=点赞最多, 3=评论最多, 4=投稿最多/Order key: 1=highest views, 2=most likes, 3=most comments, 4=most submissions | |
| time_filter | No | 时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days | |
| billboard_tag | No | 榜单标签,0=全部,其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface |
tikhub_get_api_v1_douyin_creator_fetch_creator_material_center_bGet creator material center billboardInspect
Get creator material center billboard Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order_key | No | 排序键: 1=播放最高, 2=点赞最多, 3=评论最多, 4=热度最高/Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity | |
| time_filter | No | 时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days | |
| billboard_tag | No | 榜单标签,0=全部,其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface |
tikhub_get_api_v1_douyin_creator_fetch_creator_material_center_cGet creator material center configInspect
Get creator material center config Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_creator_fetch_creator_material_center_r获取话题/热点相关视频/Get topic or hot spot related videosInspect
获取话题/热点相关视频/Get topic or hot spot related videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页数量/Items per page | |
| offset | No | 偏移量/Offset | |
| query_id | Yes | 查询ID/Query ID (话题ID/热点ID,从其他榜单接口获取) | |
| billboard_type | No | 榜单类型/Billboard type (2=热点, 3=话题, 4=道具, 5=音乐) |
tikhub_get_api_v1_douyin_creator_fetch_industry_category_configGet industry category configInspect
Get industry category config Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_creator_fetch_mission_task_listGet mission task listInspect
Get mission task list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页数量/Items per page | |
| cursor | No | 游标/Cursor (分页) | |
| keyword | No | 关键词/Keyword (任务名称或ID) | |
| pay_type | No | 付费类型/Pay type (1=视频等级, 2=自定义, 3=按转化付费, 4=按有效播放量, 5=按销售量, 9=按核销量, 14=按付费分佣) | |
| tab_scene | No | 场景类型/Scene type (1=可投稿, 2=可报名, 3=好物测评) | |
| industry_lv1 | No | 一级行业/Primary industry (-1=全部) | |
| industry_lv2 | No | 二级行业/Secondary industry (-1=全部) | |
| mission_type | No | 任务类型/Mission type | |
| platform_channel | No | 平台渠道/Platform channel (1=抖音视频, 2=抖音直播, 3=抖音图文) | |
| publish_time_start | No | 发布开始时间/Publish start time (时间戳) | |
| quick_selector_scene | No | 快速选择场景/Quick selector (1=高收益, 4=保底收入, 5=合作过) | |
| greater_than_cost_progress | No | 成本进度/Cost progress (20=高于20%, 50=高于50%, 80=高于80%) |
tikhub_get_api_v1_douyin_creator_fetch_user_searchSearch usersInspect
Search users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_name | Yes | 用户名/Username (支持抖音号和抖音昵称) |
tikhub_get_api_v1_douyin_creator_fetch_video_danmaku_listGet video danmaku listInspect
Get video danmaku list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Items per page | |
| offset | No | 偏移量/Offset (starting position) | |
| item_id | Yes | 作品ID/Video item ID | |
| is_blocked | No | 是否被屏蔽/Is blocked | |
| order_type | No | 排序类型/Order type (1=时间排序, 2=其他排序) |
tikhub_get_api_v1_douyin_index_fetch_all_areaGet all area listInspect
Get all area list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_index_fetch_all_valid_dateGet all valid datesInspect
Get all valid dates Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_index_fetch_content_publish_trendContent publish trendInspect
Content publish trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部**(同 fetch_item_query 的 category_id 但不接受 0)/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_get_api_v1_douyin_index_fetch_content_valid_dateGet content valid dateInspect
Get content valid date Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_index_fetch_current_hot_topicGet current hot topicsInspect
Get current hot topics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_index_fetch_encrypt_user_idEncrypt Douyin uid to user_idInspect
Encrypt Douyin uid to user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 抖音 uid (纯数字) / Douyin uid (numeric). Example: 3100268042915212 |
tikhub_get_api_v1_douyin_index_fetch_hot_detailGet hot topic detailInspect
Get hot topic detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| topic_name | Yes | 热点名称/Hot topic name |
tikhub_get_api_v1_douyin_index_fetch_hot_trend_wordGet hot trend wordsInspect
Get hot trend words Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | 推荐词类型/Word type: 0(搜索热词/Search words), 1(内容热词/Content words) | |
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) |
tikhub_get_api_v1_douyin_index_fetch_hot_wordsGet hot wordsInspect
Get hot words Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) |
tikhub_get_api_v1_douyin_index_fetch_insight_get_recGet related insight recommendationsInspect
Get related insight recommendations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| report_id | Yes | 报告ID/Report ID |
tikhub_get_api_v1_douyin_index_fetch_insight_recommendGet recommended insight reportsInspect
Get recommended insight reports Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_index_fetch_item_filter_optionsGet video search filter optionsInspect
Get video search filter options Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_index_fetch_report_detailGet report detailInspect
Get report detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| report_id | Yes | 报告ID/Report ID. Example: 1081 |
tikhub_get_api_v1_douyin_index_fetch_valid_date_for_relationGet valid date for relationInspect
Get valid date for relation Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_web_encrypt_uid_to_sec_user_idEncrypt user uid to sec_user_idInspect
Encrypt user uid to sec_user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户uid(short_id)/User uid(short_id) |
tikhub_get_api_v1_douyin_web_fetch_batch_user_profile_v1Get batch user profile (up to 10)Inspect
Get batch user profile (up to 10) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_user_ids | Yes | 用户sec_user_id列表,用逗号分隔/User sec_user_id list, separated by commas |
tikhub_get_api_v1_douyin_web_fetch_batch_user_profile_v2Get batch user profile (up to 50)Inspect
Get batch user profile (up to 50) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_user_ids | Yes | 用户sec_user_id列表,用逗号分隔/User sec_user_id list, separated by commas |
tikhub_get_api_v1_douyin_web_fetch_cartoon_awemeAnime VideoInspect
Anime Video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 每页数量/Number per page | |
| cookie | No | 用户自行提供的Cookie/User provided Cookie | |
| refresh_index | No | 翻页索引/Paging index |
tikhub_get_api_v1_douyin_web_fetch_douyin_web_guest_cookieGet the guest Cookie of Douyin WebInspect
Get the guest Cookie of Douyin Web Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_agent | Yes | 用户浏览器代理/User browser agent |
tikhub_get_api_v1_douyin_web_fetch_food_awemeFood VideoInspect
Food Video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 每页数量/Number per page | |
| cookie | No | 用户自行提供的Cookie/User provided Cookie | |
| refresh_index | No | 翻页索引/Paging index |
tikhub_get_api_v1_douyin_web_fetch_game_awemeGame VideoInspect
Game Video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 每页数量/Number per page | |
| cookie | No | 用户自行提供的Cookie/User provided Cookie | |
| refresh_index | No | 翻页索引/Paging index |
tikhub_get_api_v1_douyin_web_fetch_hot_search_resultGet Douyin hot search resultsInspect
Get Douyin hot search results Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_web_fetch_knowledge_awemeKnowledge VideoInspect
Knowledge Video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 每页数量/Number per page | |
| cookie | No | 用户自行提供的Cookie/User provided Cookie | |
| refresh_index | No | 翻页索引/Paging index |
tikhub_get_api_v1_douyin_web_fetch_live_gift_rankingGet live room gift user rankingInspect
Get live room gift user ranking Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间room_id/Room room_id | |
| rank_type | No | 排行类型/Leaderboard type |
tikhub_get_api_v1_douyin_web_fetch_live_im_fetchDouyin live room danmaku parametersInspect
Douyin live room danmaku parameters Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间号/Live room id | |
| user_unique_id | Yes | 用户唯一ID/User unique ID |
tikhub_get_api_v1_douyin_web_fetch_music_awemeMusic VideoInspect
Music Video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 每页数量/Number per page | |
| cookie | No | 用户自行提供的Cookie/User provided Cookie | |
| refresh_index | No | 翻页索引/Paging index |
tikhub_get_api_v1_douyin_web_fetch_one_videoGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id | |
| need_anchor_info | No | 是否需要锚点信息/Whether anchor information is needed |
tikhub_get_api_v1_douyin_web_fetch_one_video_danmakuGet single video danmaku dataInspect
Get single video danmaku data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品id/Video id | |
| duration | Yes | 视频总时长/Video total duration | |
| end_time | Yes | 结束时间/End time | |
| start_time | Yes | 开始时间/Start time |
tikhub_get_api_v1_douyin_web_fetch_one_video_v2Get single video data V2Inspect
Get single video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_web_fetch_series_awemeSeries VideoInspect
Series Video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 每页数量/Number per page | |
| cookie | No | 用户自行提供的Cookie/User provided Cookie | |
| offset | Yes | 页码/Page number | |
| content_type | Yes | 短剧类型/Subtype |
tikhub_get_api_v1_douyin_web_fetch_user_collects_videosGet user collection dataInspect
Get user collection data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| counts | No | 每页数量/Number per page | |
| max_cursor | No | 最大游标/Maximum cursor | |
| collects_id | Yes | 收藏夹id/Collection id |
tikhub_get_api_v1_douyin_web_fetch_user_fans_listGet user fans listInspect
Get user fans list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| max_time | No | 最大时间戳/Maximum timestamp | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id | |
| source_type | No | 来源类型/Source type |
tikhub_get_api_v1_douyin_web_fetch_user_following_listGet user following listInspect
Get user following list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| max_time | No | 最大时间戳/Maximum timestamp | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id | |
| source_type | No | 来源类型/Source type |
tikhub_get_api_v1_douyin_web_fetch_user_live_info_by_uidGet user live information by UIDInspect
Get user live information by UID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户UID/User UID |
tikhub_get_api_v1_douyin_web_fetch_user_live_videosGet user live video dataInspect
Get user live video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| webcast_id | Yes | 直播间webcast_id/Room webcast_id |
tikhub_get_api_v1_douyin_web_fetch_user_live_videos_by_room_id_vGets the live stream data of the specified user by room_id V2Inspect
Gets the live stream data of the specified user by room_id V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间room_id/Room room_id |
tikhub_get_api_v1_douyin_web_fetch_user_live_videos_by_sec_uidGet live video data of specified user by sec_uidInspect
Get live video data of specified user by sec_uid Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_uid | Yes | 用户sec_uid/User sec_uid |
tikhub_get_api_v1_douyin_web_fetch_user_mix_videosGet user mix video dataInspect
Get user mix video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| counts | No | 每页数量/Number per page | |
| mix_id | Yes | 合辑id/Mix id | |
| max_cursor | No | 最大游标/Maximum cursor |
tikhub_get_api_v1_douyin_web_fetch_user_post_videosGet user homepage video dataInspect
Get user homepage video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cookie | No | 用户网页版抖音Cookie/Your web version of Douyin Cookie | |
| max_cursor | No | 最大游标/Maximum cursor | |
| filter_type | No | 过滤类型/Filter type | |
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_douyin_web_fetch_user_profile_by_short_idGet user information by Short IDInspect
Get user information by Short ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| short_id | Yes | 用户Short ID/User Short ID |
tikhub_get_api_v1_douyin_web_fetch_user_profile_by_uidGet user information by UIDInspect
Get user information by UID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户UID/User UID |
tikhub_get_api_v1_douyin_web_fetch_video_channel_resultDouyin video channel dataInspect
Douyin video channel data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| tag_id | Yes | 标签id/Tag id | |
| refresh_index | No | 刷新索引/Refresh index |
tikhub_get_api_v1_douyin_web_fetch_video_comment_repliesGet comment replies data of specified videoInspect
Get comment replies data of specified video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| item_id | Yes | 作品id/Video id | |
| comment_id | Yes | 评论id/Comment id |
tikhub_get_api_v1_douyin_web_fetch_video_commentsGet single video comments dataInspect
Get single video comments data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_douyin_web_fetch_video_high_quality_play_urlGet the highest quality play URL of the videoInspect
Get the highest quality play URL of the video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 可选,请求出口地区(ISO 国家代码,如 CN/US/HK),国内用户传 CN 可拿到国内 CDN 域名以加快下载速度 / Optional, ISO country code (e.g. CN/US/HK). Pass CN to get China-region CDN URLs for faster download in mainland China. | |
| aweme_id | No | 作品id/Video id | |
| share_url | No | 可选,分享链接/Optional, share link |
tikhub_get_api_v1_douyin_web_generate_ttwidGenerate ttwidInspect
Generate ttwid Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_agent | No |
tikhub_get_api_v1_douyin_web_generate_wss_xb_signatureGenerate barrage xb signatureInspect
Generate barrage xb signature Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 房间号/Room ID | |
| user_agent | Yes | 用户浏览器代理/User browser agent | |
| user_unique_id | Yes | 用户唯一ID/User unique ID |
tikhub_get_api_v1_douyin_web_get_aweme_idExtract single video idInspect
Extract single video id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes |
tikhub_get_api_v1_douyin_web_get_sec_user_idExtract single user idInspect
Extract single user id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes |
tikhub_get_api_v1_douyin_web_get_webcast_idExtract webcast idInspect
Extract webcast id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes |
tikhub_get_api_v1_douyin_web_handler_shorten_url生成短链接Inspect
生成短链接 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| target_url | Yes | 待转换的短链接/Target URL to be converted |
tikhub_get_api_v1_douyin_web_handler_user_profileGet information of specified user by sec_user_idInspect
Get information of specified user by sec_user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_douyin_web_handler_user_profile_v2Get information of specified user by unique_idInspect
Get information of specified user by unique_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| unique_id | Yes | 用户unique_id/User unique_id |
tikhub_get_api_v1_douyin_web_handler_user_profile_v3Get information of specified user by uidInspect
Get information of specified user by uid Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户uid(short_id)/User uid(short_id) |
tikhub_get_api_v1_douyin_web_handler_user_profile_v4Get information of specified user by sec_user_id (gender, age, live level、brand)Inspect
Get information of specified user by sec_user_id (gender, age, live level、brand) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_douyin_web_webcast_id_2_room_idWebcast id to room idInspect
Webcast id to room id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| webcast_id | Yes | 直播间号/Webcast id |
tikhub_get_api_v1_douyin_xingtu_author_content_hot_comment_keywoGet Author Content Hot Comment Keywords V1Inspect
Get Author Content Hot Comment Keywords V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_author_homepage_videos_v1Get Author Homepage Videos V1Inspect
Get Author Homepage Videos V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,从1开始,每页20条/Page number, starts from 1, 20 items per page | |
| oAuthorId | Yes | 星图达人ID/Xingtu author ID | |
| videoType | No | 流量类型:ALL/PERSONAL/XINGTU / Traffic type: ALL/PERSONAL/XINGTU | |
| onlyAssign | No | 是否仅返回指派视频/Only return assigned videos |
tikhub_get_api_v1_douyin_xingtu_author_hot_comment_tokens_v1Get Author Hot Comment Tokens V1Inspect
Get Author Hot Comment Tokens V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_get_sign_imageGet Sign ImageInspect
Get Sign Image Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uri | Yes | 图片的uri/Image URI | |
| format | No | 图片格式/Image format | |
| durationTS | No | 有效期时长(秒)/Duration in seconds |
tikhub_get_api_v1_douyin_xingtu_get_xingtu_kolid_by_sec_user_idGet XingTu kolid by Douyin sec_user_idInspect
Get XingTu kolid by Douyin sec_user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_user_id | Yes | 抖音用户sec_user_id/Douyin User sec_user_id |
tikhub_get_api_v1_douyin_xingtu_get_xingtu_kolid_by_uidGet XingTu kolid by Douyin User IDInspect
Get XingTu kolid by Douyin User ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 抖音用户ID/Douyin User ID |
tikhub_get_api_v1_douyin_xingtu_get_xingtu_kolid_by_unique_idGet XingTu kolid by Douyin unique_idInspect
Get XingTu kolid by Douyin unique_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| unique_id | Yes | 抖音号/Douyin User unique_id |
tikhub_get_api_v1_douyin_xingtu_kol_audience_portrait_v1Get kol Audience Portrait V1Inspect
Get kol Audience Portrait V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_kol_base_info_v1Get kol Base Info V1Inspect
Get kol Base Info V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId | |
| platformChannel | Yes | 平台渠道/Platform Channel |
tikhub_get_api_v1_douyin_xingtu_kol_conversion_ability_analysisGet kol Conversion Ability Analysis V1Inspect
Get kol Conversion Ability Analysis V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId | |
| _range | Yes | 时间范围/Time Range |
tikhub_get_api_v1_douyin_xingtu_kol_convert_video_display_v1Get kol Convert Video Display V1Inspect
Get kol Convert Video Display V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | 页码/Page | |
| kolId | Yes | 用户的kolId/User kolId | |
| detailType | Yes | 详情类型/Detail Type |
tikhub_get_api_v1_douyin_xingtu_kol_cp_info_v1Get kol Cp Info V1Inspect
Get kol Cp Info V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_kol_daily_fans_v1Get kol Daily Fans V1Inspect
Get kol Daily Fans V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId | |
| endDate | Yes | 结束日期/End Date | |
| startDate | Yes | 开始日期/Start Date |
tikhub_get_api_v1_douyin_xingtu_kol_data_overview_v1Get kol Data Overview V1Inspect
Get kol Data Overview V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| _type | Yes | 类型/Type | |
| kolId | Yes | 用户的kolId/User kolId | |
| _range | Yes | 范围/Range | |
| flowType | Yes | 流量类型/Flow Type | |
| onlyAssign | No | 是否指派/Whether assigned (optional) |
tikhub_get_api_v1_douyin_xingtu_kol_fans_portrait_v1Get kol Fans Portrait V1Inspect
Get kol Fans Portrait V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId | |
| fansType | No | 粉丝类型/Fans Type |
tikhub_get_api_v1_douyin_xingtu_kol_link_struct_v1Get kol Link Struct V1Inspect
Get kol Link Struct V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_kol_rec_videos_v1Get kol Rec Videos V1Inspect
Get kol Rec Videos V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_kol_service_price_v1Get kol Service Price V1Inspect
Get kol Service Price V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId | |
| platformChannel | Yes | 平台渠道/Platform Channel |
tikhub_get_api_v1_douyin_xingtu_kol_touch_distribution_v1Get kol Touch Distribution V1Inspect
Get kol Touch Distribution V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_kol_video_performance_v1Get kol Video Performance V1Inspect
Get kol Video Performance V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId | |
| onlyAssign | Yes | 是否只显示分配作品/Whether to display only assigned works |
tikhub_get_api_v1_douyin_xingtu_kol_xingtu_index_v1Get kol Xingtu Index V1Inspect
Get kol Xingtu Index V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| kolId | Yes | 用户的kolId/User kolId |
tikhub_get_api_v1_douyin_xingtu_search_kol_v1Search Kol V1Inspect
Search Kol V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | 页码/Page | |
| keyword | Yes | 关键词/Keyword | |
| platformSource | Yes | 平台来源/Platform Source |
tikhub_get_api_v1_douyin_xingtu_search_kol_v2Search Kol Advanced V2Inspect
Search Kol Advanced V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 关键词/Keyword | |
| contentTag | No | 内容标签(可选)/Content Tag (optional), 例如 tag-1 或 tag_level_two-7 | |
| followerRange | No | 粉丝范围(可选)/Follower Range (optional), 例如 10-100 表示10万-100万粉丝 |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_audience_distributGet Author Audience DistributionInspect
Get Author Audience Distribution Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| link_type | Yes | 受众画像类型,必填;示例值5/Audience profile link type, required; example: 5 | |
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_base_infoGet Author Base InfoInspect
Get Author Base Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| recommend | No | 是否返回推荐信息/Whether to return recommendation info | |
| o_author_id | Yes | 创作者ID/Creator author ID | |
| need_sec_uid | No | 是否返回sec_uid/Whether to return sec_uid | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel | |
| need_linkage_info | No | 是否返回联动信息/Whether to return linkage info |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_business_card_infoGet Author Business Card InfoInspect
Get Author Business Card Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator author ID |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_commerce_spread_inGet Author Commerce Spread InfoInspect
Get Author Commerce Spread Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator ID |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_content_hot_keyworGet Author Content Hot KeywordsInspect
Get Author Content Hot Keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| author_id | Yes | 创作者ID/Creator author ID | |
| keyword_type | No | 热词类型/Keyword type |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_convert_abilityGet Author Convert AbilityInspect
Get Author Convert Ability Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| time_range | No | 时间档,默认2/Time range tier, default 2 | |
| industry_id | No | 行业ID,0=不限/Industry ID, 0=unlimited | |
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_convert_videos_or获取创作者转化视频/商品明细/Get Author Convert Videos or ProductsInspect
获取创作者转化视频/商品明细/Get Author Convert Videos or Products Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| time_range | No | 时间档,默认2/Time range tier, default 2 | |
| detail_type | No | 明细类型,1=相关视频,2=相关商品/Detail type, 1=videos, 2=products | |
| industry_id | No | 行业ID,0=不限/Industry ID, 0=unlimited | |
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_cp_infoGet Author CP InfoInspect
Get Author CP Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_daily_fansGet Author Daily FansInspect
Get Author Daily Fans Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | 结束日期,格式YYYYMMDD,可选/End date, format YYYYMMDD, optional | |
| author_id | Yes | 创作者ID/Creator ID | |
| start_date | No | 起始日期,格式YYYYMMDD,可选/Start date, format YYYYMMDD, optional | |
| author_type | No | 达人类型,可选/Author type, optional | |
| platform_source | No | 平台来源/Platform source |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_daily_linkGet Author Daily LinkInspect
Get Author Daily Link Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | Yes | 结束日期,建议YYYYMMDD/End date, YYYYMMDD recommended | |
| link_type | Yes | 星图连接指标类型ID/Xingtu link metric type ID | |
| start_date | Yes | 开始日期,建议YYYYMMDD/Start date, YYYYMMDD recommended | |
| industry_id | No | 行业ID,0为不限/Industry ID, 0 for all | |
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源,抖音为1/Platform source, 1 for Douyin | |
| platform_channel | No | 平台渠道,短视频为1/Platform channel, 1 for short video |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_daily_link_scoreGet Author Daily Link ScoreInspect
Get Author Daily Link Score Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | Yes | 结束日期,建议YYYYMMDD/End date, YYYYMMDD recommended | |
| start_date | Yes | 开始日期,建议YYYYMMDD/Start date, YYYYMMDD recommended | |
| industry_id | No | 行业ID,0为不限/Industry ID, 0 for all | |
| o_author_id | Yes | 创作者ID/Creator ID | |
| link_score_type | Yes | 星图连接指数类型ID/Xingtu link-score type ID | |
| platform_source | No | 平台来源,抖音为1/Platform source, 1 for Douyin | |
| platform_channel | No | 平台渠道,短视频为1/Platform channel, 1 for short video |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_fans_distributionGet Author Fans DistributionInspect
Get Author Fans Distribution Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_homepage_videosGet Author Homepage VideosInspect
Get Author Homepage Videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| end_time | No | 作品发布结束时间,unix秒/Publish end time, unix seconds | |
| start_time | No | 作品发布起始时间,unix秒/Publish start time, unix seconds | |
| o_author_id | Yes | 创作者ID/Creator ID | |
| is_star_item | No | 1=仅星图作品,0=仅非星图作品,不传=全部/1=star items only, 0=non-star only, omit=all |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_hot_comment_tokensGet Author Hot Comment TokensInspect
Get Author Hot Comment Tokens Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| num | No | 返回热词数量/Number of hot tokens | |
| author_id | Yes | 创作者ID/Creator author ID | |
| without_emoji | No | 是否排除emoji/Whether to exclude emoji |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_link_infoGet Author Link InfoInspect
Get Author Link Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| industy_tag | No | 行业标签,0=不限/Industry tag, 0=unlimited | |
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_local_infoGet Author Local InfoInspect
Get Author Local Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| time_range | No | 时间范围(天)/Time range in days | |
| o_author_id | Yes | 创作者ID/Creator author ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_market_fieldsGet Author Market FieldsInspect
Get Author Market Fields Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| market_scene | No | 市场场景,1=默认场景/Market scene, 1=default |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_rec_videos_v2Get Author Recommended Videos V2Inspect
Get Author Recommended Videos V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源,1=抖音/Platform source, 1=Douyin | |
| platform_channel | No | 平台渠道,1=抖音短视频/Platform channel, 1=Douyin video |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_show_itemsGet Author Show ItemsInspect
Get Author Show Items Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| flow_type | No | 流量类型/Flow type | |
| o_author_id | Yes | 创作者ID/Creator author ID | |
| only_assign | No | 仅看指派视频/Only show assigned videos | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_spread_infoGet Author Spread InfoInspect
Get Author Spread Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | 视频类型,1=个人视频/Video type, 1=personal video | |
| range | No | 时间范围,2=近30天,3=近90天/Time range, 2=last 30 days, 3=last 90 days | |
| flow_type | No | 流量类型/Flow type | |
| o_author_id | Yes | 创作者ID/Creator author ID | |
| only_assign | No | 仅看指派视频/Only assigned videos | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_spread_videosGet Author Spread VideosInspect
Get Author Spread Videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源,抖音为1/Platform source, 1 for Douyin | |
| platform_channel | No | 平台渠道,短视频为1/Platform channel, 1 for short video |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_touch_distributionGet Author Touch DistributionInspect
Get Author Touch Distribution Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_get_api_v1_douyin_xingtu_v2_get_author_video_distributionGet Author Video DistributionInspect
Get Author Video Distribution Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| o_author_id | Yes | 创作者ID/Creator ID | |
| platform_source | No | 平台来源,抖音为1/Platform source, 1 for Douyin | |
| platform_channel | No | 平台渠道,短视频为1/Platform channel, 1 for short video |
tikhub_get_api_v1_douyin_xingtu_v2_get_content_trend_guideGet Content Trend GuideInspect
Get Content Trend Guide Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_xingtu_v2_get_demander_mcn_listGet Demander MCN ListInspect
Get Demander MCN List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| mcn_name | No | MCN机构名称,支持模糊搜索/MCN name, supports fuzzy search | |
| order_by | No | 排序方式/Sort by |
tikhub_get_api_v1_douyin_xingtu_v2_get_excellent_case_category_lGet Excellent Case Category ListInspect
Get Excellent Case Category List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| platform_source | No | 平台来源/Platform source |
tikhub_get_api_v1_douyin_xingtu_v2_get_ip_activity_detailGet IP Activity DetailInspect
Get IP Activity Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | 活动ID,从get_ip_activity_list获取/Activity ID from get_ip_activity_list |
tikhub_get_api_v1_douyin_xingtu_v2_get_ip_activity_industry_listGet IP Activity Industry ListInspect
Get IP Activity Industry List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_douyin_xingtu_v2_get_item_play_countGet Item Play CountInspect
Get Item Play Count Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频(item) ID/Video (item) ID | |
| need_cover_url | No | 是否返回封面URL/Whether to return cover URL | |
| platform_source | No | 平台来源/Platform source |
tikhub_get_api_v1_douyin_xingtu_v2_get_playlet_actor_rank_listGet Playlet Actor Rank ListInspect
Get Playlet Actor Rank List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | 统计日期,格式YYYYMMDD/Date, format YYYYMMDD | |
| name | No | 榜单名称/Ranking name | |
| period | No | 统计周期,7=周榜,30=月榜/Period, 7=weekly, 30=monthly | |
| category | No | 分类/Category | |
| qualifier | No | 达人类型,空字符串=不限/Actor type, empty=all |
tikhub_get_api_v1_douyin_xingtu_v2_get_ranking_list_catalogGet Ranking List CatalogInspect
Get Ranking List Catalog Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| codes | No | 分类代码,默认为空字符串/Classification codes, default is empty string | |
| biz_scene | No | 业务场景/Business scene |
tikhub_get_api_v1_douyin_xingtu_v2_get_ranking_list_dataGet Ranking List DataInspect
Get Ranking List Data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | 榜单类型代码/Ranking type code | |
| date | No | 统计日期,格式YYYYMMDD/Date, format YYYYMMDD | |
| period | No | 统计周期,7=周榜,30=月榜/Period, 7=weekly, 30=monthly | |
| version | No | 版本/Version | |
| qualifier | No | 榜单分类ID,从get_ranking_list_catalog获取/Category qualifier_id |
tikhub_get_api_v1_douyin_xingtu_v2_get_resource_listGet Resource ListInspect
Get Resource List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| resource_id | Yes | 资源ID/Resource ID |
tikhub_get_api_v1_douyin_xingtu_v2_get_search_field_optionsGet Search Field OptionsInspect
Get Search Field Options Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| task_category | No | 合作对象,1=抖音视频 6=抖音直播 11=头条图文/Task category, 1=Douyin video, 6=Douyin live, 11=Toutiao article | |
| platform_source | No | 平台来源,1=抖音 2=头条/Platform source, 1=Douyin, 2=Toutiao |
tikhub_get_api_v1_douyin_xingtu_v2_get_user_profile_qrcodeGet User Profile QRCodeInspect
Get User Profile QRCode Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_uid | No | 用户sec_uid(与core_user_id二选一)/User sec_uid (pick one with core_user_id) | |
| core_user_id | No | 用户核心ID(与sec_uid二选一)/User core ID (pick one with sec_uid) |
tikhub_get_api_v1_douyin_xingtu_v2_get_xingtu_kolid_by_sec_userGet Xingtu Author ID by Douyin sec_user_idInspect
Get Xingtu Author ID by Douyin sec_user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_user_id | Yes | 抖音用户sec_user_id/Douyin User sec_user_id |
tikhub_get_api_v1_douyin_xingtu_v2_get_xingtu_kolid_by_uidGet Xingtu Author ID by Douyin UIDInspect
Get Xingtu Author ID by Douyin UID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 抖音用户ID/Douyin User ID (uid) |
tikhub_get_api_v1_douyin_xingtu_v2_get_xingtu_kolid_by_unique_idGet Xingtu Author ID by Douyin unique_idInspect
Get Xingtu Author ID by Douyin unique_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| unique_id | Yes | 抖音号/Douyin User unique_id |
tikhub_get_api_v1_douyin_xingtu_v2_search_anchorSearch AnchorInspect
Search Anchor Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | 达人类型ID,多个用逗号分隔,如`1,6`/Creator category IDs, comma-separated | |
| page | No | 页码/Page number | |
| gender | No | 达人性别,1=男,2=女/Creator gender, 1=male, 2=female | |
| cpe_max | No | 预期CPE上限/Maximum expected CPE | |
| cpe_min | No | 预期CPE下限/Minimum expected CPE | |
| cpm_max | No | 预期CPM上限/Maximum expected CPM | |
| cpm_min | No | 预期CPM下限/Minimum expected CPM | |
| keyword | Yes | 搜索关键词,可为主播昵称、抖音号、星图ID或直播内容词/Search keyword: nickname, Douyin ID, Xingtu ID or live content word | |
| fans_max | No | 粉丝数上限/Maximum followers | |
| fans_min | No | 粉丝数下限/Minimum followers | |
| price_max | No | 主播报价上限,提供时必须同时提供price_type/Maximum anchor price | |
| price_min | No | 主播报价下限,提供时必须同时提供price_type/Minimum anchor price | |
| sort_type | No | 排序方式,1=升序,2=降序/Sort type, 1=asc, 2=desc | |
| price_type | No | 直播报价类型,固定为9;仅与price_min/price_max配合使用/Live-stream price type, fixed to 9 | |
| sort_field | No | 排序字段,默认score综合排序/Sort field, default score (comprehensive) | |
| extra_filter | No | 额外画像筛选的JSON数组字符串,每项必须包含非空字符串field_name和field_value;支持内容主题、观众/粉丝画像、八大人群和地域等维度/Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings | |
| persona_tags | No | persona_tags | |
| task_category | No | 合作对象/Cooperation target | |
| author_list_id | No | 主题推荐达人清单ID/Featured creator list ID | |
| marketing_target | No | 营销目标/Marketing target | |
| expected_play_max | No | 预期播放量上限/Maximum expected plays | |
| expected_play_min | No | 预期播放量下限/Minimum expected plays | |
| first_industry_id | No | 适配行业ID/Industry ID | |
| interact_rate_max | No | 互动率上限,0-1小数/Maximum interaction rate, 0-1 decimal | |
| interact_rate_min | No | 互动率下限,0-1小数,0.02=2%/Minimum interaction rate, 0-1 decimal | |
| play_over_rate_max | No | 完播率上限,0-1小数/Maximum play-completion rate, 0-1 decimal | |
| play_over_rate_min | No | 完播率下限,0-1小数/Minimum play-completion rate, 0-1 decimal | |
| burst_text_rate_max | No | 爆文率上限,0-1小数/Maximum viral-post rate, 0-1 decimal | |
| burst_text_rate_min | No | 爆文率下限,0-1小数/Minimum viral-post rate, 0-1 decimal |
tikhub_get_api_v1_douyin_xingtu_v2_search_creatorSearch CreatorInspect
Search Creator Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | 达人类型ID,多个用逗号分隔,如`1,6`/Creator category IDs, comma-separated | |
| page | No | 页码/Page number | |
| gender | No | 达人性别,1=男,2=女/Creator gender, 1=male, 2=female | |
| cpe_max | No | 预期CPE上限/Maximum expected CPE | |
| cpe_min | No | 预期CPE下限/Minimum expected CPE | |
| cpm_max | No | 预期CPM上限/Maximum expected CPM | |
| cpm_min | No | 预期CPM下限/Minimum expected CPM | |
| keyword | No | 可选搜索词;留空时仅按筛选条件浏览。seach_type=2匹配昵称,=3匹配内容/Optional keyword; empty means filter-only browsing | |
| fans_max | No | 粉丝数上限/Maximum followers | |
| fans_min | No | 粉丝数下限/Minimum followers | |
| price_max | No | 达人报价上限,提供时必须同时提供price_type/Maximum creator price | |
| price_min | No | 达人报价下限,提供时必须同时提供price_type/Minimum creator price | |
| sort_type | No | 排序方式,1=升序,2=降序/Sort type, 1=asc, 2=desc | |
| price_type | No | 短视频报价时长档位:1=1-20秒、2=21-60秒、3=60秒以上;仅与price_min/price_max配合使用/Creator video price tier | |
| seach_type | No | 搜索方式,2=按昵称找人,3=按内容找人/Search mode: 2=nickname, 3=content | |
| sort_field | No | 排序字段,默认score综合排序/Sort field, default score (comprehensive) | |
| extra_filter | No | 额外画像筛选的JSON数组字符串,每项必须包含非空字符串field_name和field_value;支持内容主题、观众/粉丝画像、八大人群和地域等维度/Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings | |
| persona_tags | No | persona_tags | |
| task_category | No | 合作对象/Cooperation target | |
| author_list_id | No | 主题推荐达人清单ID/Featured creator list ID | |
| time_range_days | No | 内容搜索时间范围,30/90/180天,仅seach_type=3时生效/Content time range; only for seach_type=3 | |
| marketing_target | No | 营销目标/Marketing target | |
| expected_play_max | No | 预期播放量上限/Maximum expected plays | |
| expected_play_min | No | 预期播放量下限/Minimum expected plays | |
| first_industry_id | No | 适配行业ID,0=不限/Industry ID, 0=unlimited | |
| interact_rate_max | No | 互动率上限,0-1小数/Maximum interaction rate, 0-1 decimal | |
| interact_rate_min | No | 互动率下限,0-1小数,0.02=2%/Minimum interaction rate, 0-1 decimal | |
| play_over_rate_max | No | 完播率上限,0-1小数/Maximum play-completion rate, 0-1 decimal | |
| play_over_rate_min | No | 完播率下限,0-1小数/Minimum play-completion rate, 0-1 decimal | |
| burst_text_rate_max | No | 爆文率上限,0-1小数/Maximum viral-post rate, 0-1 decimal | |
| burst_text_rate_min | No | 爆文率下限,0-1小数/Minimum viral-post rate, 0-1 decimal |
tikhub_get_api_v1_douyin_xingtu_v2_search_toutiao_creatorSearch Toutiao CreatorInspect
Search Toutiao Creator Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | 达人类型ID,多个用逗号分隔,如`1,6`/Creator category IDs, comma-separated | |
| page | No | 页码/Page number | |
| gender | No | 达人性别,1=男,2=女/Creator gender, 1=male, 2=female | |
| cpe_max | No | 预期CPE上限/Maximum expected CPE | |
| cpe_min | No | 预期CPE下限/Minimum expected CPE | |
| cpm_max | No | 预期CPM上限/Maximum expected CPM | |
| cpm_min | No | 预期CPM下限/Minimum expected CPM | |
| keyword | Yes | 搜索关键词,可为创作者昵称、头条号或内容词/Search keyword: nickname, Toutiao ID or content word | |
| fans_max | No | 粉丝数上限/Maximum followers | |
| fans_min | No | 粉丝数下限/Minimum followers | |
| price_max | No | 图文报价上限,提供时必须同时提供price_type/Maximum image-text price | |
| price_min | No | 图文报价下限,提供时必须同时提供price_type/Minimum image-text price | |
| sort_type | No | 排序方式,1=升序,2=降序/Sort type, 1=asc, 2=desc | |
| price_type | No | 头条图文报价类型,固定为11;仅与price_min/price_max配合使用/Toutiao image-text price type, fixed to 11 | |
| sort_field | No | 排序字段,默认score综合排序/Sort field, default score (comprehensive) | |
| extra_filter | No | 额外画像筛选的JSON数组字符串,每项必须包含非空字符串field_name和field_value;支持内容主题、观众/粉丝画像、八大人群和地域等维度/Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings | |
| persona_tags | No | persona_tags | |
| task_category | No | 合作对象/Cooperation target | |
| author_list_id | No | 主题推荐达人清单ID/Featured creator list ID | |
| marketing_target | No | 营销目标/Marketing target | |
| expected_play_max | No | 预期播放量上限/Maximum expected plays | |
| expected_play_min | No | 预期播放量下限/Minimum expected plays | |
| first_industry_id | No | 适配行业ID/Industry ID | |
| interact_rate_max | No | 互动率上限,0-1小数/Maximum interaction rate, 0-1 decimal | |
| interact_rate_min | No | 互动率下限,0-1小数,0.02=2%/Minimum interaction rate, 0-1 decimal | |
| play_over_rate_max | No | 完播率上限,0-1小数/Maximum play-completion rate, 0-1 decimal | |
| play_over_rate_min | No | 完播率下限,0-1小数/Minimum play-completion rate, 0-1 decimal | |
| burst_text_rate_max | No | 爆文率上限,0-1小数/Maximum viral-post rate, 0-1 decimal | |
| burst_text_rate_min | No | 爆文率下限,0-1小数/Minimum viral-post rate, 0-1 decimal |
tikhub_get_api_v1_hybrid_video_dataHybrid: video dataInspect
Hybrid: video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| minimal | No | 是否返回最小数据/Whether to return minimal data | |
| base64_url | No | 是否Base64编码提交URL/Base64 encoding URL |
tikhub_get_api_v1_instagram_v1_fetch_citiesGet cities by countryInspect
Get cities by country Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| country_code | Yes | 国家代码(如US、CN、JP)/Country code (e.g. US, CN, JP) |
tikhub_get_api_v1_instagram_v1_fetch_comment_repliesGet comment repliesInspect
Get comment replies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| min_id | No | 分页游标,从上一次响应的next_min_id获取/Pagination cursor from previous response's next_min_id | |
| media_id | Yes | 帖子ID(媒体ID)/Post ID (Media ID) | |
| comment_id | Yes | 父评论ID/Parent comment ID |
tikhub_get_api_v1_instagram_v1_fetch_explore_sectionsGet explore page sectionsInspect
Get explore page sections Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_instagram_v1_fetch_hashtag_postsGet posts by hashtagInspect
Get posts by hashtag Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| hashtag | Yes | 话题标签名称(不含#号)/Hashtag name (without #) | |
| end_cursor | No | 分页游标,用于获取下一页/Pagination cursor for next page |
tikhub_get_api_v1_instagram_v1_fetch_location_infoGet location infoInspect
Get location info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| location_id | Yes | 地点ID/Location ID |
tikhub_get_api_v1_instagram_v1_fetch_location_postsGet posts by locationInspect
Get posts by location Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tab | No | 排序方式:ranked(热门)/recent(最新)/Sorting: ranked(top)/recent(latest) | |
| end_cursor | No | 分页游标,用于获取下一页/Pagination cursor for next page | |
| location_id | Yes | 地点ID/Location ID |
tikhub_get_api_v1_instagram_v1_fetch_locationsGet locations by cityInspect
Get locations by city Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| city_id | Yes | 城市ID(从fetch_cities获取)/City ID (from fetch_cities) |
tikhub_get_api_v1_instagram_v1_fetch_music_postsGet posts using specific musicInspect
Get posts using specific music Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| max_id | No | 分页游标,用于获取下一页/Pagination cursor for next page | |
| music_id | No | 音乐ID/Music ID | |
| music_url | No | 音乐URL(与music_id二选一)/Music URL (alternative to music_id) |
tikhub_get_api_v1_instagram_v1_fetch_post_by_idGet post by IDInspect
Get post by ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | Yes | 帖子ID/Post ID |
tikhub_get_api_v1_instagram_v1_fetch_post_by_urlGet post by URLInspect
Get post by URL Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_url | Yes | 帖子URL/Post URL |
tikhub_get_api_v1_instagram_v1_fetch_post_by_url_v2Get post by URL V2Inspect
Get post by URL V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_url | Yes | 帖子URL/Post URL |
tikhub_get_api_v1_instagram_v1_fetch_post_comments_v2Instagram: fetch post comments v2 (v1)Inspect
Instagram: fetch post comments v2 (v1) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| min_id | No | 分页游标,从上一次响应的next_min_id获取/Pagination cursor from previous response's next_min_id | |
| media_id | Yes | 帖子ID(媒体ID)/Post ID (Media ID) | |
| sort_order | No | 排序方式:popular(热门)/recent(最新)/Sorting: popular/recent |
tikhub_get_api_v1_instagram_v1_fetch_search搜索用户/话题/地点/Search users/hashtags/placesInspect
搜索用户/话题/地点/Search users/hashtags/places Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword | |
| select | No | 筛选类型:users/hashtags/places,不传则返回全部/Filter type: users/hashtags/places, omit for all |
tikhub_get_api_v1_instagram_v1_fetch_section_postsGet posts by sectionInspect
Get posts by section Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Count per page | |
| max_id | No | 分页游标,用于获取下一页/Pagination cursor for next page | |
| section_id | Yes | 分类ID(从fetch_explore_sections获取)/Section ID (from fetch_explore_sections) |
tikhub_get_api_v1_instagram_v1_fetch_user_about_infoGet user about infoInspect
Get user about info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | Instagram用户ID/Instagram user ID |
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_idGet user data by user IDInspect
Get user data by user ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | Instagram用户ID/Instagram user ID |
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_id_v2Get user data by user ID V2Inspect
Get user data by user ID V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | Instagram用户ID/Instagram user ID |
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_usernameGet user data by usernameInspect
Get user data by username Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | Instagram用户名/Instagram username |
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_username_v2Get user data by username V2Inspect
Get user data by username V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | Instagram用户名/Instagram username |
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_username_v3Get user data by username V3Inspect
Get user data by username V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | Instagram用户名/Instagram username |
tikhub_get_api_v1_instagram_v1_fetch_user_postsGet user posts listInspect
Get user posts list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Count per page | |
| max_id | No | 分页游标,用于获取下一页/Pagination cursor for next page | |
| user_id | Yes | Instagram用户ID/Instagram user ID |
tikhub_get_api_v1_instagram_v1_fetch_user_posts_v2Get user posts list V2Inspect
Get user posts list V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Count per page | |
| user_id | Yes | Instagram用户ID/Instagram user ID | |
| end_cursor | No | 分页游标,用于获取下一页/Pagination cursor for next page |
tikhub_get_api_v1_instagram_v1_fetch_user_reelsGet user Reels listInspect
Get user Reels list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Count per page | |
| max_id | No | 分页游标,用于获取下一页/Pagination cursor for next page | |
| user_id | Yes | Instagram用户ID/Instagram user ID |
tikhub_get_api_v1_instagram_v1_fetch_user_repostsGet user reposts listInspect
Get user reposts list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| max_id | No | 分页游标,用于获取下一页/Pagination cursor for next page | |
| user_id | Yes | Instagram用户ID/Instagram user ID |
tikhub_get_api_v1_instagram_v1_fetch_user_tagged_postsGet user tagged postsInspect
Get user tagged posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Count per page | |
| user_id | Yes | Instagram用户ID/Instagram user ID | |
| end_cursor | No | 分页游标,用于获取下一页/Pagination cursor for next page |
tikhub_get_api_v1_instagram_v1_media_id_to_shortcodeConvert media ID to shortcodeInspect
Convert media ID to shortcode Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| media_id | Yes | 帖子Media ID/Post media ID |
tikhub_get_api_v1_instagram_v1_shortcode_to_media_idConvert shortcode to media IDInspect
Convert shortcode to media ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| shortcode | Yes | 帖子Shortcode/Post shortcode |
tikhub_get_api_v1_instagram_v1_user_id_to_usernameGet user info by user IDInspect
Get user info by user ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_instagram_v2_fetch_comment_repliesGet comment repliesInspect
Get comment replies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| comment_id | Yes | 评论ID/Comment ID | |
| code_or_url | Yes | 帖子Shortcode或URL/Post shortcode or URL | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_hashtag_postsGet hashtag postsInspect
Get hashtag posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 话题关键词(不含#号)/Hashtag keyword (without #) | |
| feed_type | No | 帖子类型: top(热门), recent(最新), reels(仅Reels)/Feed type: top, recent, or reels | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_highlight_storiesGet highlight storiesInspect
Get highlight stories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| highlight_id | Yes | 精选ID/Highlight ID |
tikhub_get_api_v1_instagram_v2_fetch_location_postsGet location postsInspect
Get location posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| location_id | Yes | 地点ID/Location ID | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_music_postsGet music postsInspect
Get music posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pagination_token | No | 分页token/Pagination token | |
| audio_canonical_id | Yes | 音频ID/Audio ID |
tikhub_get_api_v1_instagram_v2_fetch_post_commentsGet post commentsInspect
Get post comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort_by | No | 排序方式: recent(最新) 或 popular(热门)/Sort by: recent or popular | |
| code_or_url | Yes | 帖子Shortcode或URL/Post shortcode or URL | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_post_infoGet post infoInspect
Get post info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code_or_url | Yes | 帖子Shortcode或URL/Post shortcode or URL |
tikhub_get_api_v1_instagram_v2_fetch_post_likesGet post likesInspect
Get post likes Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_cursor | No | 分页游标/Pagination cursor | |
| code_or_url | Yes | 帖子Shortcode或URL/Post shortcode or URL |
tikhub_get_api_v1_instagram_v2_fetch_similar_usersGet similar usersInspect
Get similar users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username |
tikhub_get_api_v1_instagram_v2_fetch_user_followersGet user followersInspect
Get user followers Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_user_followingGet user followingInspect
Get user following Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_user_highlightsGet user highlightsInspect
Get user highlights Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username |
tikhub_get_api_v1_instagram_v2_fetch_user_infoGet user infoInspect
Get user info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username |
tikhub_get_api_v1_instagram_v2_fetch_user_postsGet user postsInspect
Get user posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_user_reelsGet user reelsInspect
Get user reels Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_fetch_user_storiesGet user storiesInspect
Get user stories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username |
tikhub_get_api_v1_instagram_v2_fetch_user_tagged_postsGet user tagged postsInspect
Get user tagged posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| username | No | 用户名/Username | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_general_searchGeneral searchInspect
General search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_media_id_to_shortcodeConvert media ID to shortcodeInspect
Convert media ID to shortcode Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| media_id | Yes | 帖子Media ID/Post media ID |
tikhub_get_api_v1_instagram_v2_search_by_coordinatesSearch locations by coordinatesInspect
Search locations by coordinates Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| latitude | Yes | 纬度/Latitude | |
| longitude | Yes | 经度/Longitude |
tikhub_get_api_v1_instagram_v2_search_hashtagsSearch hashtagsInspect
Search hashtags Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_instagram_v2_search_locationsSearch locationsInspect
Search locations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_instagram_v2_search_musicSearch musicInspect
Search music Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_instagram_v2_search_reelsSearch reelsInspect
Search reels Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword | |
| pagination_token | No | 分页token/Pagination token |
tikhub_get_api_v1_instagram_v2_search_usersSearch usersInspect
Search users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_instagram_v2_shortcode_to_media_idConvert shortcode to media IDInspect
Convert shortcode to media ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| shortcode | Yes | 帖子Shortcode/Post shortcode |
tikhub_get_api_v1_instagram_v2_user_id_to_usernameGet user info by user IDInspect
Get user info by user ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_instagram_v3_bulk_translate_commentsInstagram: bulk translate comments (v3)Inspect
Instagram: bulk translate comments (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| comment_ids | Yes | 评论ID列表,逗号分隔/Comment ID list, comma separated |
tikhub_get_api_v1_instagram_v3_extract_shortcodeInstagram: extract shortcode (v3)Inspect
Instagram: extract shortcode (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Instagram帖子完整URL/Full Instagram post URL |
tikhub_get_api_v1_instagram_v3_general_searchInstagram: general search (v3)Inspect
Instagram: general search (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword | |
| rank_token | No | 排序token,首次请求不传,从上一次响应获取/Rank token, omit for first request, get from previous response | |
| next_max_id | No | 分页ID,首次请求不传,从上一次响应的next_max_id获取/Pagination ID, omit for first request, get from previous response next_max_id | |
| enable_metadata | No | 是否启用元数据/Enable metadata |
tikhub_get_api_v1_instagram_v3_get_comment_repliesInstagram: get comment replies (v3)Inspect
Instagram: get comment replies (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| min_id | No | 分页游标,首次请求不传,从上一次响应的 next_min_child_cursor 获取/Pagination cursor, omit for first request, get from previous response next_min_child_cursor | |
| media_id | Yes | 帖子媒体ID/Post media ID | |
| comment_id | Yes | 父评论ID/Parent comment ID |
tikhub_get_api_v1_instagram_v3_get_exploreInstagram: get explore (v3)Inspect
Instagram: get explore (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| max_id | No | 分页游标,首次请求不传,从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id |
tikhub_get_api_v1_instagram_v3_get_hashtag_postsInstagram: get hashtag posts (v3)Inspect
Instagram: get hashtag posts (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | Yes | 话题关键词(不含#号)/Hashtag keyword (without #) | |
| max_id | No | 翻页游标/Pagination cursor |
tikhub_get_api_v1_instagram_v3_get_highlight_storiesInstagram: get highlight stories (v3)Inspect
Instagram: get highlight stories (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| last | No | 获取最后N条/Get last N items | |
| first | No | 每页数量/Items per page | |
| reel_ids | No | 精选ID列表,逗号分隔,如不提供则仅查询highlight_id/Highlight ID list, comma separated, if not provided only query highlight_id | |
| highlight_id | Yes | 精选ID/Highlight ID (格式/format: highlight:xxx) |
tikhub_get_api_v1_instagram_v3_get_location_infoInstagram: get location info (v3)Inspect
Instagram: get location info (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| location_id | Yes | 地点ID/Location ID | |
| show_nearby | No | 是否显示附近地点/Whether to show nearby places |
tikhub_get_api_v1_instagram_v3_get_location_nearbyInstagram: get location nearby (v3)Inspect
Instagram: get location nearby (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| location_id | Yes | 地点ID(数字)/Location ID (numeric) |
tikhub_get_api_v1_instagram_v3_get_location_postsInstagram: get location posts (v3)Inspect
Instagram: get location posts (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tab | No | 帖子类型/Post type. 可选值/Options: ranked(热门/top), recent(最新/latest). Example: ranked | |
| after | No | 翻页游标,从上一次响应的end_cursor获取/Pagination cursor from previous response end_cursor | |
| first | No | 翻页时每页数量/Posts per page | |
| location_id | Yes | 地点ID/Location ID | |
| page_size_override | No | 每页数量/Page size |
tikhub_get_api_v1_instagram_v3_get_music_postsInstagram: get music posts (v3)Inspect
Instagram: get music posts (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| max_id | No | 翻页游标/Pagination cursor | |
| audio_cluster_id | Yes | 音频ID/Audio ID |
tikhub_get_api_v1_instagram_v3_get_post_commentsInstagram: get post comments (v3)Inspect
Instagram: get post comments (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | 帖子短代码/Post shortcode (e.g., DUajw4YkorV) | |
| min_id | No | 分页游标,首次请求不传,从上一次响应的 next_min_id 获取/Pagination cursor, omit for first request, get from previous response next_min_id | |
| sort_order | No | 排序方式/Sort order. 可选值/Options: popular(热门), newest(最新). Example: popular |
tikhub_get_api_v1_instagram_v3_get_post_infoInstagram: get post info (v3)Inspect
Instagram: get post info (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | 帖子URL/Post URL(与 media_id 二选一;支持 /p/、/reel/、/reels/、/tv/ 形式) | |
| media_id | No | 帖子媒体ID/Post media ID(与 url 二选一) |
tikhub_get_api_v1_instagram_v3_get_post_info_by_codeInstagram: get post info by code (v3)Inspect
Instagram: get post info by code (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | 帖子短代码/Post shortcode |
tikhub_get_api_v1_instagram_v3_get_post_likesInstagram: get post likes (v3)Inspect
Instagram: get post likes (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | 帖子短代码/Post shortcode |
tikhub_get_api_v1_instagram_v3_get_post_oembedInstagram: get post oembed (v3)Inspect
Instagram: get post oembed (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Instagram帖子的完整URL/Full URL of Instagram post | |
| maxwidth | No | 最大宽度(像素)/Max width in pixels | |
| hidecaption | No | 是否隐藏帖子文本/Whether to hide caption |
tikhub_get_api_v1_instagram_v3_get_recommended_reelsInstagram: get recommended reels (v3)Inspect
Instagram: get recommended reels (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | 分页游标,首次请求不传,从上一次响应的 page_info.end_cursor 获取/Pagination cursor, omit for first request, get from previous response page_info.end_cursor | |
| first | No | 获取数量/Number of reels to fetch |
tikhub_get_api_v1_instagram_v3_get_similar_usersInstagram: get similar users (v3)Inspect
Instagram: get similar users (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 目标用户ID/Target user ID |
tikhub_get_api_v1_instagram_v3_get_user_aboutInstagram: get user about (v3)Inspect
Instagram: get user about (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_briefInstagram: get user brief (v3)Inspect
Instagram: get user brief (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID | |
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_followersInstagram: get user followers (v3)Inspect
Instagram: get user followers (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每次获取数量/Number of users to fetch per request | |
| max_id | No | 分页游标,首次请求不传,从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id | |
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_followingInstagram: get user following (v3)Inspect
Instagram: get user following (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每次获取数量/Number of users to fetch per request | |
| max_id | No | 分页游标,首次请求不传,从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id | |
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_former_usernamesInstagram: get user former usernames (v3)Inspect
Instagram: get user former usernames (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_highlightsInstagram: get user highlights (v3)Inspect
Instagram: get user highlights (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| last | No | 向前翻页时每页数量/Number of highlights per page (backward) | |
| after | No | 向后翻页游标/Forward pagination cursor | |
| first | No | 每页数量/Number of highlights per page | |
| before | No | 向前翻页游标/Backward pagination cursor | |
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_id_by_usernameInstagram: get user id by username (v3)Inspect
Instagram: get user id by username (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_postsInstagram: get user posts (v3)Inspect
Instagram: get user posts (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| last | No | 向前翻页时每页数量/Number of posts per page (backward) | |
| after | No | 向后翻页游标(end_cursor)/Forward pagination cursor (end_cursor) | |
| count | No | 首次请求数量/Number of posts for first request | |
| first | No | 向后翻页时每页数量/Number of posts per page (forward) | |
| before | No | 向前翻页游标(start_cursor)/Backward pagination cursor (start_cursor) | |
| username | Yes | Instagram 用户名(不含 @)/Instagram username (without @) |
tikhub_get_api_v1_instagram_v3_get_user_profileInstagram: get user profile (v3)Inspect
Instagram: get user profile (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_reelsInstagram: get user reels (v3)Inspect
Instagram: get user reels (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| last | No | 向前翻页时每页数量/Number of reels per page (backward) | |
| after | No | 向后翻页游标(end_cursor)/Forward pagination cursor (end_cursor) | |
| first | No | 向后翻页时每页数量/Number of reels per page (forward) | |
| before | No | 向前翻页游标(start_cursor)/Backward pagination cursor (start_cursor) | |
| username | Yes | 用户名/Username | |
| page_size | No | 每页视频数量/Videos per page |
tikhub_get_api_v1_instagram_v3_get_user_storiesInstagram: get user stories (v3)Inspect
Instagram: get user stories (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_get_user_tagged_postsInstagram: get user tagged posts (v3)Inspect
Instagram: get user tagged posts (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| last | No | 向前翻页时每页数量/Number of posts per page (backward) | |
| after | No | 向后翻页游标(end_cursor)/Forward pagination cursor (end_cursor) | |
| count | No | 首次请求数量/Number of posts for first request | |
| first | No | 向后翻页时每页数量/Number of posts per page (forward) | |
| before | No | 向前翻页游标(start_cursor)/Backward pagination cursor (start_cursor) | |
| username | Yes | 用户名/Username |
tikhub_get_api_v1_instagram_v3_media_id_to_shortcodeInstagram: media id to shortcode (v3)Inspect
Instagram: media id to shortcode (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| media_id | Yes | 帖子媒体ID/Post media ID |
tikhub_get_api_v1_instagram_v3_search_by_coordinatesInstagram: search by coordinates (v3)Inspect
Instagram: search by coordinates (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| latitude | Yes | 纬度/Latitude | |
| longitude | Yes | 经度/Longitude |
tikhub_get_api_v1_instagram_v3_search_hashtagsInstagram: search hashtags (v3)Inspect
Instagram: search hashtags (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword | |
| rank_token | No | 上一次搜索返回的rank_token,用于翻页/Rank token from previous search response for pagination |
tikhub_get_api_v1_instagram_v3_search_usersInstagram: search users (v3)Inspect
Instagram: search users (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword | |
| rank_token | No | 上一次搜索返回的rank_token,用于翻页/Rank token from previous search response for pagination |
tikhub_get_api_v1_instagram_v3_shortcode_to_media_idInstagram: shortcode to media id (v3)Inspect
Instagram: shortcode to media id (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| shortcode | Yes | 帖子短码/Post shortcode |
tikhub_get_api_v1_instagram_v3_translate_commentInstagram: translate comment (v3)Inspect
Instagram: translate comment (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| comment_id | Yes | 评论ID或帖子caption的media_id/Comment ID or caption media ID |
tikhub_get_api_v1_instagram_v3_user_id_to_usernameInstagram: user id to username (v3)Inspect
Instagram: user id to username (v3) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_kuaishou_app_fetch_brand_top_listKuaishou brand top listInspect
Kuaishou brand top list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| subTabId | No | ||
| subTabName | No |
tikhub_get_api_v1_kuaishou_app_fetch_hot_board_categoriesKuaishou hot categoriesInspect
Kuaishou hot categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_kuaishou_app_fetch_hot_board_detailKuaishou hot board detailInspect
Kuaishou hot board detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | No | ||
| boardType | No |
tikhub_get_api_v1_kuaishou_app_fetch_hot_search_personKuaishou hot search person boardInspect
Kuaishou hot search person board Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_kuaishou_app_fetch_live_top_listKuaishou live top listInspect
Kuaishou live top list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| subTabId | No | ||
| subTabName | No |
tikhub_get_api_v1_kuaishou_app_fetch_music_rankingMusic rankingInspect
Music ranking Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 默认 20,范围 1-50 | |
| tab_id | No | 100002=热歌榜(默认),100063=π计划推荐榜 | |
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor |
tikhub_get_api_v1_kuaishou_app_fetch_one_user_v2Get single user data V2Inspect
Get single user data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes |
tikhub_get_api_v1_kuaishou_app_fetch_one_videoVideo detailsV1Inspect
Video detailsV1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| photo_id | Yes |
tikhub_get_api_v1_kuaishou_app_fetch_one_video_by_urlFetch single video by URLInspect
Fetch single video by URL Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| share_text | Yes |
tikhub_get_api_v1_kuaishou_app_fetch_selection_feed精选/推荐Feed流/Selection feedInspect
精选/推荐Feed流/Selection feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_kuaishou_app_fetch_shopping_top_listKuaishou shopping top listInspect
Kuaishou shopping top list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| subTabId | No | ||
| subTabName | No |
tikhub_get_api_v1_kuaishou_app_fetch_tag_feedTag feedInspect
Tag feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tab | No | hot(最热门) / latest(最新发布) / image(图片) / live(直播) | |
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor | |
| tag_name | No | 话题标签建议传,等于标签名 | |
| tag_type | No | 1=话题标签,29=声音/音乐标签 | |
| tag_source | No | 2=搜索进入话题页,3=作品页声音标签 | |
| from_photo_id | No | 进入标签页的源作品 photoId(可选) | |
| general_tag_id | Yes | 话题标签传标签名或 search_tag 的数字 id;声音标签传编码串 |
tikhub_get_api_v1_kuaishou_app_fetch_user_hot_postGet user hot post dataInspect
Get user hot post data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pcursor | No | ||
| user_id | Yes |
tikhub_get_api_v1_kuaishou_app_fetch_user_live_infoGet user live infoInspect
Get user live info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes |
tikhub_get_api_v1_kuaishou_app_fetch_user_post_v2User video list V2Inspect
User video list V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | latest(最新, 默认) / hot(热门) | |
| pcursor | No | 第一次请求留空,后续传上一页响应的 pcursor | |
| user_id | Yes |
tikhub_get_api_v1_kuaishou_app_fetch_video_commentGet single video comment dataInspect
Get single video comment data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pcursor | No | ||
| photo_id | Yes |
tikhub_get_api_v1_kuaishou_app_fetch_videos_batchKuaishou batch video query APIInspect
Kuaishou batch video query API Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| photo_ids | Yes | 多个作品ID用逗号分隔,单次最多40个/Multiple photo IDs separated by commas, max 40 per request |
tikhub_get_api_v1_kuaishou_app_fetch_video_sub_commentsVideo sub commentsInspect
Video sub comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 默认 8,范围 1-20 | |
| pcursor | No | 首页留空,翻页传上一页响应的 pcursor | |
| photo_id | Yes | ||
| root_comment_id | Yes |
tikhub_get_api_v1_kuaishou_app_search_comprehensiveComprehensive searchInspect
Comprehensive search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | ||
| pcursor | No | ||
| duration | No | 可选值: all(全部), under_1_min(1分钟以内), 1_to_5_min(1-5分钟), over_5_min(5分钟以上) | |
| sort_type | No | 可选值: all(综合排序), newest(最新发布), most_likes(最多点赞) | |
| publish_time | No | 可选值: all(全部), one_day(近一日), one_week(近一周), one_month(近一月) |
tikhub_get_api_v1_kuaishou_app_search_imageSearch imageInspect
Search image Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | ||
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor |
tikhub_get_api_v1_kuaishou_app_search_liveSearch liveInspect
Search live Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | ||
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor |
tikhub_get_api_v1_kuaishou_app_search_musicSearch musicInspect
Search music Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | ||
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor |
tikhub_get_api_v1_kuaishou_app_search_tagSearch tagInspect
Search tag Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | ||
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor |
tikhub_get_api_v1_kuaishou_app_search_user_v2Search user V2Inspect
Search user V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | ||
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor / Empty for first page | |
| fans_sort | No | default / most_to_least / least_to_most | |
| user_gender | No | all / male / female | |
| user_relation | No | all / same_city / verified / live / following |
tikhub_get_api_v1_kuaishou_app_search_video_v2Search video V2Inspect
Search video V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | ||
| pcursor | No | 首次留空,翻页传上一页响应的 pcursor / Empty for first page, pass pcursor from previous response |
tikhub_get_api_v1_kuaishou_web_fetch_get_user_idFetch user IDInspect
Fetch user ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| share_link | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_kuaishou_hot_list_v1Fetch Kuaishou Hot List V1Inspect
Fetch Kuaishou Hot List V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_kuaishou_web_fetch_kuaishou_hot_list_v2Fetch Kuaishou Hot List V2Inspect
Fetch Kuaishou Hot List V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| board_type | No |
tikhub_get_api_v1_kuaishou_web_fetch_one_videoGet single video data V1Inspect
Get single video data V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| share_text | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_one_video_by_urlFetch single video by URLInspect
Fetch single video by URL Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_one_video_commentFetch video commentsInspect
Fetch video comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pcursor | No | ||
| photo_id | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_one_video_sub_commentFetch video sub commentsInspect
Fetch video sub comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pcursor | No | ||
| photo_id | Yes | ||
| root_comment_id | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_one_video_v2Get single video data V2Inspect
Get single video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| photo_id | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_user_collectFetch user collectInspect
Fetch user collect Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pcursor | No | ||
| user_id | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_user_infoFetch user infoInspect
Fetch user info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes |
tikhub_get_api_v1_kuaishou_web_fetch_user_live_replayFetch user live replayInspect
Fetch user live replay Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pcursor | No | ||
| user_id | Yes |
tikhub_get_api_v1_lemon8_app_fetch_discover_bannersGet banners of discover pageInspect
Get banners of discover page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_lemon8_app_fetch_discover_tabGet main content of discover pageInspect
Get main content of discover page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_lemon8_app_fetch_discover_tab_information_tabsGet Editor's Picks of discover pageInspect
Get Editor's Picks of discover page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_lemon8_app_fetch_hot_search_keywordsGet hot search keywordsInspect
Get hot search keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_lemon8_app_fetch_post_comment_listGet comments list of specified postInspect
Get comments list of specified post Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 翻页参数/Pagination parameter | |
| item_id | Yes | 作品的item_id/Post's item_id | |
| group_id | Yes | 作品的group_id/Post's group_id | |
| media_id | Yes | 作品的media_id/Post's media_id |
tikhub_get_api_v1_lemon8_app_fetch_post_detailGet information of specified postInspect
Get information of specified post Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品ID/Post ID |
tikhub_get_api_v1_lemon8_app_fetch_searchSearch APIInspect
Search API Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword | |
| order_by | No | 搜索排序方式/Search sort type | |
| max_cursor | No | 翻页参数/Pagination parameter | |
| search_tab | No | 搜索类型/Search type | |
| filter_type | No | 搜索过滤类型/Search filter type |
tikhub_get_api_v1_lemon8_app_fetch_topic_infoGet topic informationInspect
Get topic information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| forum_id | Yes | 话题ID/Topic ID |
tikhub_get_api_v1_lemon8_app_fetch_topic_post_listGet topic post listInspect
Get topic post list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| category | Yes | 话题分类 ID/Topic category ID | |
| sort_type | No | 排序方式/Sort type | |
| hashtag_name | Yes | Hashtag名称/Hashtag name | |
| max_behot_time | No | 翻页参数/Pagination parameter | |
| category_parameter | Yes | 分类参数/Category parameter |
tikhub_get_api_v1_lemon8_app_fetch_user_follower_listGet fans list of specified userInspect
Get fans list of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页参数/Pagination parameter | |
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_lemon8_app_fetch_user_following_listGet following list of specified userInspect
Get following list of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页参数/Pagination parameter | |
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_lemon8_app_fetch_user_profileGet information of specified userInspect
Get information of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_lemon8_app_get_item_idGet post ID through sharing linkInspect
Get post ID through sharing link Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| share_text | Yes | 分享链接/Share link |
tikhub_get_api_v1_lemon8_app_get_user_idGet user ID through sharing linkInspect
Get user ID through sharing link Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| share_text | Yes | 分享链接/Share link |
tikhub_get_api_v1_linkedin_web_v2_get_company_postsGet company's postsInspect
Get company's posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 公司主页 URL/Company URL | |
| start | No | 翻页偏移,第 1 页 0、第 2 页 50/Pagination offset | |
| sort_by | No | top(热门)| recent(最新) | |
| pagination_token | No | 上一次响应返回的翻页令牌/Pagination token |
tikhub_get_api_v1_linkedin_web_v2_get_company_profileGet company profileInspect
Get company profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 公司主页完整 URL/Full company URL |
tikhub_get_api_v1_linkedin_web_v2_get_job_detailGet job detailInspect
Get job detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 职位 URL/Job URL | |
| include_skills | No | 附带技能要求/Include skills | |
| include_hiring_team | No | 附带招聘团队信息/Include hiring team |
tikhub_get_api_v1_linkedin_web_v2_get_post_commentsGet post commentsInspect
Get post comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| urn | Yes | 帖子 activity urn/Post activity urn | |
| page | No | 页码,从 1 开始/Page number, starts at 1 | |
| sort_by | No | Most relevant(默认)| Most recent | |
| share_urn | No | 分享类帖子的 share urn(可选)/Share urn (optional) | |
| pagination_token | No | 上一次响应返回的翻页令牌/Pagination token |
tikhub_get_api_v1_linkedin_web_v2_get_post_detailGet post or article detailInspect
Get post or article detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 帖子或文章 URL/Post or article URL |
tikhub_get_api_v1_linkedin_web_v2_get_user_postsGet user's postsInspect
Get user's posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 用户主页 URL/Profile URL | |
| type | No | posts(发帖/转发)| comments(评论过的帖子)| reactions(点赞过的帖子) | |
| start | No | 翻页偏移,第 1 页 0、第 2 页 50/Pagination offset | |
| pagination_token | No | 上一次响应返回的翻页令牌/Pagination token |
tikhub_get_api_v1_linkedin_web_v2_get_user_profileGet user profileInspect
Get user profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 用户主页完整 URL/Full profile URL |
tikhub_get_api_v1_linkedin_web_v2_search_jobsSearch jobsInspect
Search jobs Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| start | No | 翻页偏移,第 1 页 0、第 2 页 25/Pagination offset | |
| sort_by | No | Most relevant / Most recent | |
| geo_code | No | LinkedIn 地区码,92000000 为全球/LinkedIn geo code, 92000000 = worldwide | |
| keywords | No | 关键词/Keywords | |
| functions | No | 职能过滤,可重复传多个/Functions, repeatable Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| job_types | No | Full-time / Part-time / Contract / Temporary / Internship / Volunteer Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| title_ids | No | 职位标题 ID,可重复传多个/Title ids, repeatable Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| easy_apply | No | 仅 Easy Apply 职位/Easy-apply jobs only | |
| industries | No | 行业过滤,可重复传多个/Industries, repeatable Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| company_ids | No | 公司 ID,可重复传多个/Company ids, repeatable Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| date_posted | No | Any time / Past month / Past week / Past 24 hours | |
| onsite_remotes | No | On-site / Remote / Hybrid Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| experience_levels | No | Internship / Entry level / Associate / Mid-Senior level / Director / Executive Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| under_10_applicants | No | 仅申请人数少于 10 的职位/Under 10 applicants only |
tikhub_get_api_v1_pipixia_app_fetch_hashtag_detailGet hashtag detailInspect
Get hashtag detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| hashtag_id | Yes | 话题id/Hashtag id |
tikhub_get_api_v1_pipixia_app_fetch_hashtag_post_listGet hashtag post listInspect
Get hashtag post list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标/Page cursor | |
| feed_count | No | 翻页数量/Page count | |
| hashtag_id | Yes | 话题id/Hashtag id | |
| hashtag_sort_type | No | 话题排序类型/Hashtag sort type | |
| hashtag_request_type | No | 话题请求类型/Hashtag request type |
tikhub_get_api_v1_pipixia_app_fetch_home_feedGet home feedInspect
Get home feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标/Page cursor |
tikhub_get_api_v1_pipixia_app_fetch_home_short_drama_feedGet home short drama feedInspect
Get home short drama feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number |
tikhub_get_api_v1_pipixia_app_fetch_hot_search_board_detailGet hot search board detailInspect
Get hot search board detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| block_type | Yes | 榜单类型/Board type |
tikhub_get_api_v1_pipixia_app_fetch_hot_search_board_listGet hot search board listInspect
Get hot search board list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_pipixia_app_fetch_hot_search_wordsGet hot search wordsInspect
Get hot search words Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_pipixia_app_fetch_increase_post_view_countIncrease post view countInspect
Increase post view count Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cell_id | Yes | 作品id/Video id | |
| cell_type | No | 作品类型/Video type |
tikhub_get_api_v1_pipixia_app_fetch_post_comment_listGet post comment listInspect
Get post comment list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 翻页游标/Page cursor | |
| cell_id | Yes | 作品id/Video id | |
| cell_type | No | 作品类型/Video type |
tikhub_get_api_v1_pipixia_app_fetch_post_detailGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cell_id | Yes | 作品id/Video id | |
| cell_type | No | 作品类型/Video type |
tikhub_get_api_v1_pipixia_app_fetch_post_statisticsGet post statisticsInspect
Get post statistics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cell_id | Yes | 作品id/Video id |
tikhub_get_api_v1_pipixia_app_fetch_searchSearch APIInspect
Search API Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 翻页游标/Page cursor | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_type | No | 搜索类型/Search type |
tikhub_get_api_v1_pipixia_app_fetch_short_urlGenerate short URLInspect
Generate short URL Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| original_url | Yes | 原始链接/Original URL |
tikhub_get_api_v1_pipixia_app_fetch_user_follower_listGet user follower listInspect
Get user follower list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标/Page cursor | |
| user_id | Yes | 用户id/User id |
tikhub_get_api_v1_pipixia_app_fetch_user_following_listGet user following listInspect
Get user following list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标/Page cursor | |
| user_id | Yes | 用户id/User id |
tikhub_get_api_v1_pipixia_app_fetch_user_infoGet user informationInspect
Get user information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户id/User id |
tikhub_get_api_v1_pipixia_app_fetch_user_post_listGet user post listInspect
Get user post list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标/Page cursor | |
| user_id | Yes | 用户id/User id | |
| feed_count | No | 翻页数量/Page count |
tikhub_get_api_v1_reddit_app_check_subreddit_mutedCheck if Subreddit is MutedInspect
Check if Subreddit is Muted Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| subreddit_id | Yes | 版块ID/Subreddit ID |
tikhub_get_api_v1_reddit_app_fetch_comment_repliesFetch Reddit APP Comment Replies (Sub-comments)Inspect
Fetch Reddit APP Comment Replies (Sub-comments) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | Yes | 评论游标/Comment cursor from more.cursor field | |
| post_id | Yes | 帖子ID/Post ID | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| sort_type | No | 排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_community_highlightsFetch Reddit APP Community HighlightsInspect
Fetch Reddit APP Community Highlights Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| subreddit_id | Yes | 版块ID/Subreddit ID |
tikhub_get_api_v1_reddit_app_fetch_dynamic_searchFetch Reddit APP Dynamic Search ResultsInspect
Fetch Reddit APP Dynamic Search Results Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式(仅适用于post/comment/media)/Sort method (only for post/comment/media): RELEVANCE(相关性), HOT(热门), TOP(最受欢迎), NEW(最新), COMMENTS(评论数,仅post) | |
| after | No | 分页游标;need_format=true时使用pageInfo.endCursor / Pagination cursor; use pageInfo.endCursor when need_format=true | |
| query | Yes | 搜索关键词或搜索表达式;帖子搜索默认可匹配部分关键词,支持 AND、OR、NOT、括号分组、引号短语和字段限定 / Search keywords or expression; post searches may match only some keywords. Supports AND, OR, NOT, grouping, quoted phrases and field filters | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| allow_nsfw | No | 是否允许NSFW内容/Allow NSFW content: 0, 1 | |
| time_range | No | 时间范围(仅适用于post/media)/Time range (only for post/media): all(所有时间), year(去年), month(上月), week(上周), day(今天), hour(过去1小时) | |
| need_format | No | true时data仅包含children和pageInfo,并精简每条结果的冗余字段;false时保留原始搜索结构 / When true, data contains only children and pageInfo with redundant result fields removed; false preserves the original search structure | |
| safe_search | No | 安全搜索设置/Safe search setting: unset, strict | |
| search_type | No | 搜索类型/Search type: post(帖子), community(社区), comment(评论), media(媒体), people(用户) |
tikhub_get_api_v1_reddit_app_fetch_games_feedFetch Reddit APP Games FeedInspect
Fetch Reddit APP Games Feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort method: NEW, HOT, TOP, RISING | |
| time | No | 时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR | |
| after | No | 分页参数/Pagination parameter | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_home_feedFetch Reddit APP Home FeedInspect
Fetch Reddit APP Home Feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort method: HOT, NEW, TOP, BEST, CONTROVERSIAL | |
| after | No | 分页参数/Pagination parameter for fetching next page | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| filter_posts | No | 过滤掉指定的帖子ID列表/Filter out specified post IDs Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. |
tikhub_get_api_v1_reddit_app_fetch_news_feedFetch Reddit APP News FeedInspect
Fetch Reddit APP News Feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | 分页参数/Pagination parameter | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| subtopic_ids | No | 子话题ID列表/Subtopic IDs list Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. |
tikhub_get_api_v1_reddit_app_fetch_popular_feedFetch Reddit APP Popular FeedInspect
Fetch Reddit APP Popular Feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING | |
| time | No | 时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR | |
| after | No | 分页参数/Pagination parameter | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| filter_posts | No | 过滤帖子ID列表/Filter post IDs Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. |
tikhub_get_api_v1_reddit_app_fetch_post_commentsFetch Reddit APP Post CommentsInspect
Fetch Reddit APP Post Comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | 分页参数/Pagination parameter for fetching next page | |
| post_id | Yes | 帖子ID/Post ID | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| sort_type | No | 排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_post_detailsFetch Single Reddit Post DetailsInspect
Fetch Single Reddit Post Details Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | Yes | 帖子ID/Post ID | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| comment_id | No | 评论ID/Comment ID (when include_comment_id is True) | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| include_comment_id | No | 是否包含特定评论ID/Include specific comment ID |
tikhub_get_api_v1_reddit_app_fetch_post_details_batchFetch Reddit Post Details in Batch (Max 5)Inspect
Fetch Reddit Post Details in Batch (Max 5) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| post_ids | Yes | 帖子ID列表,逗号分隔,最多5条/Post IDs comma-separated, max 5 | |
| comment_id | No | 评论ID/Comment ID (when include_comment_id is True) | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| include_comment_id | No | 是否包含特定评论ID/Include specific comment ID |
tikhub_get_api_v1_reddit_app_fetch_post_details_batch_largeFetch Reddit Post Details in Large Batch (Max 30)Inspect
Fetch Reddit Post Details in Large Batch (Max 30) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| post_ids | Yes | 帖子ID列表,逗号分隔,最多30条/Post IDs comma-separated, max 30 | |
| comment_id | No | 评论ID/Comment ID (when include_comment_id is True) | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| include_comment_id | No | 是否包含特定评论ID/Include specific comment ID |
tikhub_get_api_v1_reddit_app_fetch_search_typeaheadFetch Reddit APP Search Typeahead SuggestionsInspect
Fetch Reddit APP Search Typeahead Suggestions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search query | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| allow_nsfw | No | 是否允许NSFW内容/Allow NSFW content: 0 or 1 | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| safe_search | No | 安全搜索设置/Safe search setting: unset, strict |
tikhub_get_api_v1_reddit_app_fetch_subreddit_feedFetch Reddit APP Subreddit FeedInspect
Fetch Reddit APP Subreddit Feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING | |
| after | No | 分页参数/Pagination parameter | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| filter_posts | No | 过滤帖子ID列表/Filter post IDs Omit this optional parameter: its query array serialization policy is not configured. Supplying an array returns a local error before gateway dispatch. | |
| subreddit_name | Yes | 版块名称/Subreddit name |
tikhub_get_api_v1_reddit_app_fetch_subreddit_infoFetch Reddit APP Subreddit InfoInspect
Fetch Reddit APP Subreddit Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| subreddit_name | No | 版块名称/Subreddit name |
tikhub_get_api_v1_reddit_app_fetch_subreddit_post_channelsFetch Reddit APP Subreddit Post ChannelsInspect
Fetch Reddit APP Subreddit Post Channels Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING | |
| range | No | 时间范围/Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| subreddit_name | No | 版块名称/Subreddit name |
tikhub_get_api_v1_reddit_app_fetch_subreddit_settingsFetch Reddit APP Subreddit SettingsInspect
Fetch Reddit APP Subreddit Settings Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| subreddit_id | Yes | 版块ID/Subreddit ID |
tikhub_get_api_v1_reddit_app_fetch_subreddit_styleFetch Reddit APP Subreddit Rules and Style InfoInspect
Fetch Reddit APP Subreddit Rules and Style Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data | |
| subreddit_name | No | 版块名称/Subreddit name |
tikhub_get_api_v1_reddit_app_fetch_trending_searchesFetch Reddit APP Trending SearchesInspect
Fetch Reddit APP Trending Searches Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_user_active_subredditsFetch User's Active SubredditsInspect
Fetch User's Active Subreddits Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| username | Yes | 用户名/Username | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_user_commentsFetch User CommentsInspect
Fetch User Comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL | |
| after | No | 分页参数/Pagination parameter | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| username | Yes | 用户名/Username | |
| page_size | No | 每页数量/Page size (default: 25) | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_user_postsFetch User PostsInspect
Fetch User Posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL | |
| after | No | 分页参数/Pagination parameter | |
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| username | Yes | 用户名/Username | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_user_profileFetch Reddit APP User ProfileInspect
Fetch Reddit APP User Profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| username | Yes | 用户名/Username | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_reddit_app_fetch_user_trophiesFetch User Public TrophiesInspect
Fetch User Public Trophies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | 返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US | |
| username | Yes | 用户名/Username | |
| need_format | No | 是否需要清洗数据/Whether to clean and format the data |
tikhub_get_api_v1_telegram_web_batch_channel_infoBatch channel infoInspect
Batch channel info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channels | Yes | 逗号分隔的频道用户名(最多20个)/Comma-separated usernames (max 20) |
tikhub_get_api_v1_telegram_web_fetch_channel_infoGet channel infoInspect
Get channel info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | 频道用户名(不含 @)/Channel username |
tikhub_get_api_v1_telegram_web_fetch_channel_postsGet channel posts (paginated)Inspect
Get channel posts (paginated) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | 取更新:传上页 after_cursor/Newer than this id | |
| limit | No | 返回条数/Number of posts | |
| before | No | 取更老:传上页 before_cursor/Older than this id | |
| channel | Yes | 频道用户名/Channel username |
tikhub_get_api_v1_telegram_web_fetch_channel_searchSearch posts in a channelInspect
Search posts in a channel Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 返回条数/Number of hits | |
| query | Yes | 关键词/Keyword | |
| channel | Yes | 频道用户名/Channel username |
tikhub_get_api_v1_telegram_web_fetch_post_comments帖子评论/讨论/Post commentsInspect
帖子评论/讨论/Post comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 返回条数/Number of comments | |
| channel | Yes | 频道用户名/Channel username | |
| post_id | Yes | 消息ID/Post ID |
tikhub_get_api_v1_telegram_web_fetch_post_detailGet single postInspect
Get single post Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | 频道用户名/Channel username | |
| post_id | Yes | 消息ID/Post ID |
tikhub_get_api_v1_telegram_web_fetch_similar_channelsSimilar channelsInspect
Similar channels Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | 频道用户名/Channel username |
tikhub_get_api_v1_threads_web_fetch_post_commentsGet post comments (no pagination)Inspect
Get post comments (no pagination) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | Yes | 帖子ID/Post ID | |
| end_cursor | No | 分页游标(本接口不支持分页,传入无效)/Pagination cursor (no pagination, has no effect) |
tikhub_get_api_v1_threads_web_fetch_post_detailGet post detailInspect
Get post detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | Yes | 帖子ID/Post ID |
tikhub_get_api_v1_threads_web_fetch_post_detail_v2Get post detail V2(supports URL)Inspect
Get post detail V2(supports URL) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | 完整帖子URL/Full post URL | |
| post_id | No | 帖子短代码/Post short code |
tikhub_get_api_v1_threads_web_fetch_user_infoGet user infoInspect
Get user info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_threads_web_fetch_user_info_by_idGet user info by IDInspect
Get user info by ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_threads_web_fetch_user_postsGet user posts (no pagination)Inspect
Get user posts (no pagination) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID | |
| end_cursor | No | 分页游标(本接口不支持分页,传入无效)/Pagination cursor (no pagination, has no effect) |
tikhub_get_api_v1_threads_web_fetch_user_repliesGet user replies (no pagination)Inspect
Get user replies (no pagination) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID | |
| end_cursor | No | 分页游标(本接口不支持分页,传入无效)/Pagination cursor (no pagination, has no effect) |
tikhub_get_api_v1_threads_web_fetch_user_repostsGet user reposts (no pagination)Inspect
Get user reposts (no pagination) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID | |
| end_cursor | No | 分页游标(本接口不支持分页,传入无效)/Pagination cursor (no pagination, has no effect) |
tikhub_get_api_v1_threads_web_search_postsSearch postsInspect
Search posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search query |
tikhub_get_api_v1_threads_web_search_profilesSearch profilesInspect
Search profiles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search query |
tikhub_get_api_v1_threads_web_search_recentSearch recent content (no pagination)Inspect
Search recent content (no pagination) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search query | |
| end_cursor | No | 分页游标(本接口不支持分页,传入无效)/Pagination cursor (no pagination, has no effect) |
tikhub_get_api_v1_threads_web_search_topSearch top content (no pagination)Inspect
Search top content (no pagination) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search query | |
| end_cursor | No | 分页游标(本接口不支持分页,传入无效)/Pagination cursor (no pagination, has no effect) |
tikhub_get_api_v1_tiktok_analytics_detect_fake_viewsDetect fake views in videoInspect
Detect fake views in video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品id/Video id | |
| content_category | No | 内容分类/Content category, options: default, entertainment, education, product, verified_large |
tikhub_get_api_v1_tiktok_analytics_fetch_comment_keywordsGet comment keywords analysisInspect
Get comment keywords analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_analytics_fetch_creator_info_and_milestGet creator info and milestonesInspect
Get creator info and milestones Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户id/User id |
tikhub_get_api_v1_tiktok_analytics_fetch_video_metricsGet video metricsInspect
Get video metrics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_app_v3_check_live_room_onlineCheck if live room is onlineInspect
Check if live room is online Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间id/Live room id |
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_infoGet shopping creator informationInspect
Get shopping creator information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| creator_uid | Yes | 创作者uid/Creator uid |
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insightsCreator Search InsightsInspect
Creator Search Insights Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tab | No | 标签页类型/Tab type (all/content_gap/follower_searched/life_style/topics/challenges/sounds/hashtags) | |
| limit | No | 每页数量/Number per page | |
| offset | No | 分页偏移量/Pagination offset | |
| force_refresh | No | 是否强制刷新/Force refresh | |
| creator_source | No | 创作者来源/Creator source | |
| category_filters | No | 分类过滤器,多个用逗号分隔/Category filters (Gaming/Fashion/Tourism/Science/Food/Sports) | |
| language_filters | No | 语言过滤器,多个用逗号分隔/Language filters (id/de/en/es/fr/pt/vi/tr/ar/th/ja/ko) |
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insights_deCreator Search Insights DetailInspect
Creator Search Insights Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | 结束时间戳(秒),仅当 time_range=custom 时生效/End timestamp (seconds), only for custom range | |
| start_date | No | 开始时间戳(秒),仅当 time_range=custom 时生效/Start timestamp (seconds), only for custom range | |
| time_range | No | 时间范围/Time range (past_7_days/past_30_days/past_60_days/past_6_months/custom) | |
| query_id_str | Yes | 搜索词条ID,从 fetch_creator_search_insights 接口获取/Query ID from fetch_creator_search_insights | |
| dimension_list | No | 维度列表,多个用逗号分隔/Dimension list (gender/age/country) |
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insights_trCreator Search Insights TrendInspect
Creator Search Insights Trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query_id_str | Yes | 搜索词条ID,从 fetch_creator_search_insights 接口获取/Query ID from fetch_creator_search_insights | |
| from_tab_path | No | 来源标签路径/From tab path | |
| query_analysis_required | No | 是否需要查询分析/Whether query analysis is required |
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insights_viCreator Search Insights VideosInspect
Creator Search Insights Videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| offset | No | 分页偏移量/Pagination offset | |
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_tiktok_app_v3_fetch_general_search_resultGet comprehensive search results of specified keywordsInspect
Get comprehensive search results of specified keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 关键词/Keyword | |
| sort_type | No | 排序类型/Sort type | |
| publish_time | No | 发布时间/Publish time |
tikhub_get_api_v1_tiktok_app_v3_fetch_hashtag_detailGet details of specified hashtagInspect
Get details of specified hashtag Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ch_id | Yes | 话题id/Hashtag id | |
| region | No | 地区/Region (US, GB, FR, JP, VN, SG) |
tikhub_get_api_v1_tiktok_app_v3_fetch_hashtag_search_resultGet hashtag search results of specified keywordsInspect
Get hashtag search results of specified keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 关键词/Keyword |
tikhub_get_api_v1_tiktok_app_v3_fetch_hashtag_video_listGet video list of specified hashtagInspect
Get video list of specified hashtag Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ch_id | Yes | 话题id/Hashtag id | |
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| region | No | 地区/Region (US, GB, FR, JP, VN, SG) |
tikhub_get_api_v1_tiktok_app_v3_fetch_live_daily_rankGet live daily rank dataInspect
Get live daily rank data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户自己的cookie/User's own cookie | |
| room_id | No | 直播间id/Live room id | |
| anchor_id | No | 主播id/Anchor id | |
| rank_type | No | 榜单类型/Rank type | |
| region_type | No | 地区类型/Region type | |
| gap_interval | No | 时间间隔/Time interval |
tikhub_get_api_v1_tiktok_app_v3_fetch_live_ranking_listGet live room ranking listInspect
Get live room ranking list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间id/Live room id | |
| anchor_id | Yes | 主播id/Anchor id |
tikhub_get_api_v1_tiktok_app_v3_fetch_live_room_infoGet data of specified live roomInspect
Get data of specified live room Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间id/Live room id |
tikhub_get_api_v1_tiktok_app_v3_fetch_live_room_product_listGet live room product list dataInspect
Get live room product list data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户自己的cookie/User's own cookie | |
| offset | No | 数量/Number | |
| region | No | 地区/Region | |
| room_id | Yes | 直播间id/Live room id | |
| author_id | Yes | 主播id/Anchor id | |
| page_size | No | 数量/Number |
tikhub_get_api_v1_tiktok_app_v3_fetch_live_room_product_list_v2Get live room product list data V2Inspect
Get live room product list data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户自己的cookie/User's own cookie | |
| offset | No | 数量/Number | |
| region | No | 地区/Region | |
| room_id | Yes | 直播间id/Live room id | |
| author_id | Yes | 主播id/Anchor id | |
| page_size | No | 数量/Number |
tikhub_get_api_v1_tiktok_app_v3_fetch_live_search_resultGet live search results of specified keywordsInspect
Get live search results of specified keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| region | No | 地区/Region | |
| keyword | Yes | 关键词/Keyword |
tikhub_get_api_v1_tiktok_app_v3_fetch_location_searchGet location search resultsInspect
Get location search results Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 关键词/Keyword |
tikhub_get_api_v1_tiktok_app_v3_fetch_music_chart_listMusic Chart ListInspect
Music Chart List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page (max 50) | |
| scene | No | 排行榜类型/Chart type (0: Top 50, 1: Viral 50) | |
| cursor | No | 分页游标/Pagination cursor |
tikhub_get_api_v1_tiktok_app_v3_fetch_music_detailGet details of specified musicInspect
Get details of specified music Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| music_id | Yes | 音乐id/Music id |
tikhub_get_api_v1_tiktok_app_v3_fetch_music_search_resultGet music search results of specified keywordsInspect
Get music search results of specified keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| region | No | 地区/Region | |
| keyword | Yes | 关键词/Keyword | |
| filter_by | No | 过滤类型/Filter type | |
| sort_type | No | 排序类型/Sort type |
tikhub_get_api_v1_tiktok_app_v3_fetch_music_video_listGet video list of specified musicInspect
Get video list of specified music Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| music_id | Yes | 音乐id/Music id |
tikhub_get_api_v1_tiktok_app_v3_fetch_one_videoGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_app_v3_fetch_one_video_v2Get single video data V2Inspect
Get single video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_app_v3_fetch_one_video_v3Get single video data V3 (support country parameter)Inspect
Get single video data V3 (support country parameter) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 国家代码/Country code | |
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_app_v3_fetch_similar_user_recommendatioSimilar User RecommendationsInspect
Similar User Recommendations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sec_uid | Yes | 用户sec_uid/User sec_uid | |
| page_token | No | 分页标记/Page token |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_country_by_usernameGet user account country by usernameInspect
Get user account country by username Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_follower_listGet follower list of specified userInspect
Get follower list of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| user_id | No | 用户ID/User ID (与sec_user_id二选一/One of user_id and sec_user_id) | |
| min_time | No | 最小时间,用于翻页/Minimum time for paging | |
| page_token | No | 翻页token/Page token | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id (与user_id二选一/One of user_id and sec_user_id) |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_following_listGet following list of specified userInspect
Get following list of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| user_id | No | 用户ID/User ID (与sec_user_id二选一/One of user_id and sec_user_id) | |
| min_time | No | 最小时间,用于翻页/Minimum time for paging | |
| page_token | No | 翻页token/Page token | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id (与user_id二选一/One of user_id and sec_user_id) |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_like_videosGet user like video dataInspect
Get user like video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| counts | No | 每页数量/Number per page | |
| max_cursor | No | 最大游标/Maximum cursor | |
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_music_listGet user music list dataInspect
Get user music list data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| sec_uid | Yes | 用户sec_uid/User sec_uid |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_post_videosGet user homepage video data V1Inspect
Get user homepage video data V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| region | No | 国家地区/Region, 可选参数,如果不传则默认使用美国地区数据,传递后会优先获取对应国家地区的数据,例如:US、GB、FR等 | |
| sort_type | No | 排序类型/Sort type | |
| unique_id | No | 用户unique_id/User unique_id | |
| max_cursor | No | 最大游标/Maximum cursor | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_post_videos_v2Get user homepage video data V2Inspect
Get user homepage video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| sort_type | No | 排序类型/Sort type | |
| unique_id | No | 用户unique_id/User unique_id | |
| max_cursor | No | 最大游标/Maximum cursor | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_post_videos_v3Get user homepage video data V3 (simplified data - faster)Inspect
Get user homepage video data V3 (simplified data - faster) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| sort_type | No | 排序类型/Sort type | |
| unique_id | No | 用户unique_id/User unique_id | |
| max_cursor | No | 最大游标/Maximum cursor | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_repost_videosGet user repost video dataInspect
Get user repost video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| user_id | Yes | 用户id/User id |
tikhub_get_api_v1_tiktok_app_v3_fetch_user_search_resultGet user search results of specified keywordsInspect
Get user search results of specified keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 关键词/Keyword | |
| user_search_other_pref | No | 根据其他偏好排序/Sort by other preferences | |
| user_search_profile_type | No | 根据账号类型排序/Sort by account type | |
| user_search_follower_count | No | 根据粉丝数排序/Sort by number of followers |
tikhub_get_api_v1_tiktok_app_v3_fetch_video_comment_repliesGet comment replies data of specified videoInspect
Get comment replies data of specified video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| item_id | Yes | 作品id/Video id | |
| comment_id | Yes | 评论id/Comment id |
tikhub_get_api_v1_tiktok_app_v3_fetch_video_commentsGet single video comments dataInspect
Get single video comments data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cursor | No | 游标/Cursor | |
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_app_v3_fetch_video_search_resultGet video search results of specified keywordsInspect
Get video search results of specified keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| offset | No | 偏移量/Offset | |
| region | No | 地区/Region | |
| keyword | Yes | 关键词/Keyword | |
| sort_type | No | 排序类型/Sort type | |
| publish_time | No | 发布时间/Publish time |
tikhub_get_api_v1_tiktok_app_v3_fetch_webcast_user_infoGet information of specified Webcast userInspect
Get information of specified Webcast user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户uid (可选,纯数字)/User uid (optional, pure number) | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_tiktok_app_v3_get_user_id_and_sec_user_id_by_uGet user_id and sec_user_id by UsernameInspect
Get user_id and sec_user_id by Username Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | 用户名/Username |
tikhub_get_api_v1_tiktok_app_v3_handler_user_profileGet information of specified userInspect
Get information of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户uid (可选,纯数字)/User uid (optional, pure number) | |
| unique_id | No | 用户unique_id (用户名)/User unique_id (username) | |
| sec_user_id | No | 用户sec_user_id/User sec_user_id |
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_keyword_searcGenerate TikTok share link, call TikTok APP, and jump to the specified keyword search resultInspect
Generate TikTok share link, call TikTok APP, and jump to the specified keyword search result Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 关键词/Keyword |
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_send_privateGenerate TikTok share link, call TikTok APP, and send private messages to specified usersInspect
Generate TikTok share link, call TikTok APP, and send private messages to specified users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户id/User id |
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_user_profileGenerate TikTok share link, call TikTok APP, and jump to the specified user profileInspect
Generate TikTok share link, call TikTok APP, and jump to the specified user profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户id/User id |
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_video_detailGenerate TikTok share link, call TikTok APP, and jump to the specified video details pageInspect
Generate TikTok share link, call TikTok APP, and jump to the specified video details page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_app_v3_search_follower_listSearch follower listInspect
Search follower list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword | |
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_tiktok_app_v3_search_following_listSearch following listInspect
Search following list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword | |
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_tiktok_shop_web_fetch_hot_selling_products_lisGet hot selling products listInspect
Get hot selling products list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 最多返回的商品数量,1 至 100,默认20/Maximum products to return, 1 to 100, default 20 | |
| region | No | 地区代码/Region code: ID, JP, MX, MY, PH, SG, TH, VN。US、GB、BR 暂不支持 / US, GB and BR are temporarily unavailable. | |
| exclude_product_ids | No | 已获取的商品ID,英文逗号分隔,用于翻页/Previously retrieved product IDs separated by commas, used for paging |
tikhub_get_api_v1_tiktok_shop_web_fetch_product_detailGet product detail V1Inspect
Get product detail V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| seller_id | No | 卖家ID(可选)/Seller ID (optional) | |
| product_id | Yes | 商品ID/Product ID |
tikhub_get_api_v1_tiktok_shop_web_fetch_product_detail_v2Get product detail V2 (Less Data)Inspect
Get product detail V2 (Less Data) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| seller_id | No | 卖家ID(可选)/Seller ID (optional) | |
| product_id | Yes | 商品ID/Product ID |
tikhub_get_api_v1_tiktok_shop_web_fetch_product_detail_v3Get product detail V3 (Full Data)Inspect
Get product detail V3 (Full Data) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| product_id | Yes | 商品ID/Product ID |
tikhub_get_api_v1_tiktok_shop_web_fetch_product_reviews_v2Get product reviews V2Inspect
Get product reviews V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| sort_rule | No | 排序规则/Sort order: 1=推荐/Recommended, 2=最近/Most recent | |
| page_start | No | 起始页码/Page start | |
| product_id | Yes | 商品ID/Product ID | |
| filter_type | No | 筛选类型/Filter type: 1=全部/All, 2=含图片或视频/With images or videos, 3=真实购买/Verified purchase | |
| filter_value | No | 筛选值/Filter value: filter_type=1 时 6=全部、5-1=对应星级;filter_type=2 或 3 时固定传1 / For filter_type=1, 6=all and 5-1=star rating; use 1 for filter_type=2 or 3 |
tikhub_get_api_v1_tiktok_shop_web_fetch_products_by_category_idGet products by category IDInspect
Get products by category ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 翻页偏移量/Offset for pagination | |
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| category_id | Yes | 分类ID/Category ID |
tikhub_get_api_v1_tiktok_shop_web_fetch_products_category_listGet product category listInspect
Get product category list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. |
tikhub_get_api_v1_tiktok_shop_web_fetch_search_products_listSearch products list V1Inspect
Search products list V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 偏移量/Offset | |
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| page_token | No | 分页标记/Page token | |
| search_word | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_tiktok_shop_web_fetch_search_products_list_v2Search products list V2 (Mobile, US only)Inspect
Search products list V2 (Mobile, US only) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 偏移量/Offset | |
| region | No | 地区代码,仅支持 US / Region code; only US is supported. | |
| page_token | No | 分页标记/Page token | |
| search_word | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_tiktok_shop_web_fetch_search_word_suggestion_vGet search keyword suggestions V2 (Mobile)Inspect
Get search keyword suggestions V2 (Mobile) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | 语言/Language | |
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| search_word | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_tiktok_shop_web_fetch_seller_products_listGet seller products list V1Inspect
Get seller products list V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX。GB 和 BR 暂不支持 / GB and BR are unavailable. | |
| seller_id | Yes | 卖家ID/Seller ID | |
| search_params | No | 搜索参数(用于分页)/Search params (for pagination) |
tikhub_get_api_v1_tiktok_shop_web_fetch_seller_products_list_v2Get seller products list V2 (Mobile, US only)Inspect
Get seller products list V2 (Mobile, US only) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码,仅支持 US / Region code; only US is supported. | |
| seller_id | Yes | 美国地区卖家ID/US seller ID | |
| searchParams | No | 搜索参数/Search params |
tikhub_get_api_v1_tiktok_web_decrypt_strdataDecrypt strDataInspect
Decrypt strData Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| encrypted_data | Yes | 加密后的strData字符串/Encrypted strData string |
tikhub_get_api_v1_tiktok_web_device_registerRegister device for TikTok WebInspect
Register device for TikTok Web Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_tiktok_web_encrypt_strdataEncrypt strDataInspect
Encrypt strData Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | 原始指纹数据字符串(JSON格式或字典字符串)/Raw fingerprint data string (JSON format or dict string) |
tikhub_get_api_v1_tiktok_web_fetch_batch_check_live_aliveBatch live room start status checkInspect
Batch live room start status check Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_ids | Yes | 直播间ID列表,用英文逗号分隔,最多支持50个/Live room ID list separated by commas, up to 50 IDs |
tikhub_get_api_v1_tiktok_web_fetch_check_live_aliveLive room start status checkInspect
Live room start status check Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间ID/Live room ID |
tikhub_get_api_v1_tiktok_web_fetch_explore_postGet explore video dataInspect
Get explore video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| categoryType | No | 作品分类/Video category |
tikhub_get_api_v1_tiktok_web_fetch_general_searchGet general search listInspect
Get general search list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户cookie(按需提供)/User cookie(if needed) | |
| offset | No | 翻页游标/Page cursor | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
tikhub_get_api_v1_tiktok_web_fetch_live_gift_listGet live room gift listInspect
Get live room gift list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | No | 直播间ID,可选参数/Live room ID, optional parameter |
tikhub_get_api_v1_tiktok_web_fetch_live_im_fetchtiktok live room danmaku parametersInspect
tiktok live room danmaku parameters Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_id | Yes | 直播间号/Live room id | |
| user_unique_id | No | 用户唯一ID/User unique ID | |
| resp_content_type | No | 响应格式: protobuf 或 json / Response format: protobuf or json |
tikhub_get_api_v1_tiktok_web_fetch_live_recommendGet live room homepage recommendation listInspect
Get live room homepage recommendation list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| related_live_tag | Yes | 相关直播标签,可选值请调用 `/fetch_live_recommend_tabs` 接口获取/Related live tag, call `/fetch_live_recommend_tabs` to get the available values |
tikhub_get_api_v1_tiktok_web_fetch_live_recommend_tabsGet available tags for live room homepage recommendationInspect
Get available tags for live room homepage recommendation Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| logid | No | 翻页游标,首页请求留空;加载更多时传入上一次响应返回的 logid/Pagination cursor, leave empty for the first page; pass the `logid` from the previous response to load more |
tikhub_get_api_v1_tiktok_web_fetch_post_ai_articleGet AI-generated article of a single videoInspect
Get AI-generated article of a single video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | 作品id/Video id |
tikhub_get_api_v1_tiktok_web_fetch_post_commentComments on a TikTok videoInspect
Comments on a TikTok video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cursor | No | 翻页游标/Page cursor | |
| aweme_id | Yes | 作品id/Video id | |
| current_region | No | 当前地区/Current region |
tikhub_get_api_v1_tiktok_web_fetch_post_comment_replyGet video comment repliesInspect
Get video comment replies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cursor | No | 翻页游标/Page cursor | |
| item_id | Yes | 作品id/Video id | |
| comment_id | Yes | 评论id/Comment id | |
| current_region | No | 当前地区/Current region |
tikhub_get_api_v1_tiktok_web_fetch_post_detailGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | 作品id/Video id | |
| region | No | 地区代码,可选;影响作品所属地区,如 US/GB/JP/ID 等,默认 US。/ Region code, optional; affects content region, e.g. US/GB/JP/ID, default US. |
tikhub_get_api_v1_tiktok_web_fetch_post_detail_v2Get single video data V2Inspect
Get single video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itemId | Yes | 作品id/Video id | |
| region | No | 地区代码,可选;影响作品所属地区,如 US/GB/JP/ID 等,默认 US。/ Region code, optional; affects content region, e.g. US/GB/JP/ID, default US. |
tikhub_get_api_v1_tiktok_web_fetch_search_keyword_suggestSearch keyword suggestInspect
Search keyword suggest Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_tiktok_web_fetch_search_liveSearch liveInspect
Search live Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cookie | No | 用户cookie(按需提供)/User cookie(if needed) | |
| offset | No | 翻页游标/Page cursor | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
tikhub_get_api_v1_tiktok_web_fetch_search_photoSearch photoInspect
Search photo Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cookie | No | 用户cookie(按需提供)/User cookie(if needed) | |
| offset | No | 翻页游标/Page offset | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
tikhub_get_api_v1_tiktok_web_fetch_search_userSearch userInspect
Search user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户cookie(按需提供)/User cookie(if needed) | |
| cursor | No | 翻页游标/Page cursor | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
tikhub_get_api_v1_tiktok_web_fetch_search_videoTiktok: Search videoInspect
Tiktok: Search video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cookie | No | 用户cookie(按需提供)/User cookie(if needed) | |
| offset | No | 翻页游标/Page cursor | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索id,翻页时需要提供/Search id, need to provide when paging |
tikhub_get_api_v1_tiktok_web_fetch_tag_detailTag DetailInspect
Tag Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag_name | Yes | Tag名称/Tag name |
tikhub_get_api_v1_tiktok_web_fetch_tag_postTag PostInspect
Tag Post Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cursor | No | 翻页游标/Page cursor | |
| challengeID | Yes | Tag ID |
tikhub_get_api_v1_tiktok_web_fetch_tiktok_live_dataGet live room information via live linkInspect
Get live room information via live link Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| live_room_url | Yes | 直播间链接/Live room link |
tikhub_get_api_v1_tiktok_web_fetch_tiktok_web_guest_cookieGet the guest CookieInspect
Get the guest Cookie Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_agent | Yes | 用户浏览器代理/User browser agent |
tikhub_get_api_v1_tiktok_web_fetch_trending_searchwordsGet daily trending search wordsInspect
Get daily trending search words Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_tiktok_web_fetch_user_collectGet user favoritesInspect
Get user favorites Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cookie | Yes | 用户cookie/User cookie | |
| cursor | No | 翻页游标/Page cursor | |
| secUid | Yes | 用户secUid/User secUid | |
| coverFormat | No | 封面格式/Cover format |
tikhub_get_api_v1_tiktok_web_fetch_user_fansGet user followersInspect
Get user followers Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| secUid | Yes | 用户secUid/User secUid | |
| maxCursor | No | 最大游标/Max cursor | |
| minCursor | No | 最小游标/Min cursor |
tikhub_get_api_v1_tiktok_web_fetch_user_followGet user followingsInspect
Get user followings Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| secUid | Yes | 用户secUid/User secUid | |
| maxCursor | No | 最大游标/Max cursor | |
| minCursor | No | 最小游标/Min cursor |
tikhub_get_api_v1_tiktok_web_fetch_user_likeGet user likesInspect
Get user likes Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cursor | No | 翻页游标/Page cursor | |
| secUid | Yes | 用户secUid/User secUid | |
| coverFormat | No | 封面格式/Cover format | |
| post_item_list_request_type | No | 排序方式/Sort type |
tikhub_get_api_v1_tiktok_web_fetch_user_live_detailGet user live detailsInspect
Get user live details Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uniqueId | Yes | 用户uniqueId/User uniqueId |
tikhub_get_api_v1_tiktok_web_fetch_user_mixGet user mix listInspect
Get user mix list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| mixId | Yes | 合辑id/Mix id | |
| cursor | No | 翻页游标/Page cursor |
tikhub_get_api_v1_tiktok_web_fetch_user_play_listGet user play listInspect
Get user play list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cursor | No | 翻页游标/Page cursor | |
| secUid | Yes | 用户secUid/User secUid |
tikhub_get_api_v1_tiktok_web_fetch_user_postGet user postsInspect
Get user posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量,最大15/Number per page, max 15 | |
| cursor | No | 翻页游标/Page cursor | |
| secUid | Yes | 用户secUid/User secUid | |
| coverFormat | No | 封面格式/Cover format | |
| post_item_list_request_type | No | 排序方式(已废弃,不再生效)/Sort type (deprecated, no longer effective) |
tikhub_get_api_v1_tiktok_web_fetch_user_profileGet user profileInspect
Get user profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| secUid | No | 用户secUid/User secUid | |
| uniqueId | No | 用户uniqueId/User uniqueId |
tikhub_get_api_v1_tiktok_web_fetch_user_repostGet user repostsInspect
Get user reposts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cursor | No | 翻页游标/Page cursor | |
| secUid | Yes | 用户secUid/User secUid | |
| coverFormat | No | 封面格式/Cover format |
tikhub_get_api_v1_tiktok_web_generate_fingerprintGenerate browser fingerprintInspect
Generate browser fingerprint Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| browser_type | No |
tikhub_get_api_v1_tiktok_web_generate_hashed_idGenerate hashed IDInspect
Generate hashed ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | 邮箱地址/Email address |
tikhub_get_api_v1_tiktok_web_generate_real_mstokenGenerate real msTokenInspect
Generate real msToken Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| browser_type | No | ||
| random_strData | No |
tikhub_get_api_v1_tiktok_web_generate_ttwidGenerate ttwidInspect
Generate ttwid Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_agent | No |
tikhub_get_api_v1_tiktok_web_generate_webidGenerate web_idInspect
Generate web_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| app_id | No | ||
| cookie | No | ||
| referer | No | ||
| user_agent | No | ||
| user_unique_id | No |
tikhub_get_api_v1_tiktok_web_get_aweme_idExtract single video idInspect
Extract single video id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 作品链接/Video link |
tikhub_get_api_v1_tiktok_web_get_live_room_idExtract live room ID from live room linkInspect
Extract live room ID from live room link Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| live_room_url | Yes | 直播间链接/Live room link |
tikhub_get_api_v1_tiktok_web_get_sec_user_idExtract user sec_user_idInspect
Extract user sec_user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 用户主页链接/User homepage link |
tikhub_get_api_v1_tiktok_web_get_unique_idGet user unique_idInspect
Get user unique_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 用户主页链接/User homepage link |
tikhub_get_api_v1_tiktok_web_get_user_idExtract user user_idInspect
Extract user user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 用户主页链接/User homepage link |
tikhub_get_api_v1_tiktok_web_tiktok_live_roomExtract live room danmakuInspect
Extract live room danmaku Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| danmaku_type | Yes | 消息类型/Message type | |
| live_room_url | Yes | 直播间链接/Live room link |
tikhub_get_api_v1_toutiao_app_get_article_infoGet information of specified articleInspect
Get information of specified article Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| group_id | Yes | 作品ID/Post ID |
tikhub_get_api_v1_toutiao_app_get_commentsGet comments of specified postInspect
Get comments of specified post Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | Yes | 偏移量/Offset | |
| group_id | Yes | 作品ID/Post ID |
tikhub_get_api_v1_toutiao_app_get_user_idGet user_id from user profileInspect
Get user_id from user profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_profile_url | Yes | 用户主页链接/User profile URL |
tikhub_get_api_v1_toutiao_app_get_user_infoGet information of specified userInspect
Get information of specified user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_toutiao_app_get_video_infoGet information of specified videoInspect
Get information of specified video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| group_id | Yes | 作品ID/Post ID |
tikhub_get_api_v1_toutiao_web_get_article_infoGet information of specified articleInspect
Get information of specified article Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品ID/Post ID |
tikhub_get_api_v1_toutiao_web_get_video_infoGet information of specified videoInspect
Get information of specified video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| aweme_id | Yes | 作品ID/Post ID |
tikhub_get_api_v1_twitter_web_fetch_latest_post_commentsTwitter: fetch latest post comments (web)Inspect
Twitter: fetch latest post comments (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| tweet_id | Yes | 推文ID/Tweet ID |
tikhub_get_api_v1_twitter_web_fetch_post_commentsTwitter: fetch post comments (web)Inspect
Twitter: fetch post comments (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| tweet_id | Yes | 推文ID/Tweet ID |
tikhub_get_api_v1_twitter_web_fetch_retweet_user_listTwitter: fetch retweet user list (web)Inspect
Twitter: fetch retweet user list (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| tweet_id | Yes | 推文ID/Tweet ID |
tikhub_get_api_v1_twitter_web_fetch_search_timelineTwitter: fetch search timeline (web)Inspect
Twitter: fetch search timeline (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| keyword | Yes | 搜索关键字/Search Keyword | |
| search_type | No | 搜索类型/Search Type |
tikhub_get_api_v1_twitter_web_fetch_trendingTwitter: fetch trending (web)Inspect
Twitter: fetch trending (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| country | No | 国家/Country |
tikhub_get_api_v1_twitter_web_fetch_tweet_detailTwitter: fetch tweet detail (web)Inspect
Twitter: fetch tweet detail (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tweet_id | Yes | 推文ID/Tweet ID |
tikhub_get_api_v1_twitter_web_fetch_user_followersTwitter: fetch user followers (web)Inspect
Twitter: fetch user followers (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| screen_name | Yes | 用户名/Screen Name |
tikhub_get_api_v1_twitter_web_fetch_user_followingsTwitter: fetch user followings (web)Inspect
Twitter: fetch user followings (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| screen_name | Yes | 用户名/Screen Name |
tikhub_get_api_v1_twitter_web_fetch_user_mediaTwitter: fetch user media (web)Inspect
Twitter: fetch user media (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标/Page Cursor | |
| rest_id | No | 用户ID/User ID | |
| screen_name | Yes | 用户名/Screen Name |
tikhub_get_api_v1_twitter_web_fetch_user_post_tweetRecent posts of an X (Twitter) userInspect
Recent posts of an X (Twitter) user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| rest_id | No | 用户ID/User ID | |
| screen_name | No | 用户名/Screen Name |
tikhub_get_api_v1_twitter_web_fetch_user_profilePublic X (Twitter) profile by handle or numeric idInspect
Public X (Twitter) profile by handle or numeric id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| rest_id | No | 用户ID(如果使用用户ID则会忽略用户名)/User ID (If the user ID is used, the user name will be ignored) | |
| screen_name | No | 用户名/Screen Name |
tikhub_get_api_v1_twitter_web_fetch_user_tweet_repliesTwitter: fetch user tweet replies (web)Inspect
Twitter: fetch user tweet replies (web) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 游标/Cursor | |
| screen_name | Yes | 用户名/Screen Name |
tikhub_get_api_v1_weibo_app_fetch_ai_smart_searchAI Smart SearchInspect
AI Smart Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| query | Yes | 搜索关键词 |
tikhub_get_api_v1_weibo_app_fetch_home_recommend_feedGet home recommend feedInspect
Get home recommend feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,首页不传,第二页传2 | |
| count | No | 每页数量 |
tikhub_get_api_v1_weibo_app_fetch_hot_searchGet hot searchInspect
Get hot search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| count | No | 每页数量 | |
| category | No | 热搜分类: mineband=我的, realtimehot=热搜, social=社会, fun=文娱, technologynav=科技, lifenav=生活, region=同城, sportnav=体育, gamenav=ACG | |
| region_name | No | 同城热搜城市名称,仅 category=region 时有效,支持: 北京/上海/广州/深圳/杭州/成都/重庆/武汉/南京/天津/西安/长沙/郑州/苏州/东莞/青岛/沈阳/合肥等,默认北京 |
tikhub_get_api_v1_weibo_app_fetch_hot_search_briefGet hot search briefInspect
Get hot search brief Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_app_fetch_hot_search_categoriesGet hot search categoriesInspect
Get hot search categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_app_fetch_search_allComprehensive searchInspect
Comprehensive search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| query | Yes | 搜索关键词 | |
| search_type | No | 搜索类型: 1=综合, 61=实时, 3=用户, 64=视频, 63=图片, 62=关注, 60=热门, 21=全网, 38=话题, 98=超话, 92=地点, 97=商品 |
tikhub_get_api_v1_weibo_app_fetch_status_commentsGet post commentsInspect
Get post comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| max_id | No | 翻页游标 | |
| sort_type | No | 排序类型: 0=按热度排序, 1=按时间排序 | |
| status_id | Yes | 微博ID |
tikhub_get_api_v1_weibo_app_fetch_status_detailGet post detailInspect
Get post detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| status_id | Yes | 微博ID |
tikhub_get_api_v1_weibo_app_fetch_status_likesGet post likesInspect
Get post likes Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| status_id | Yes | 微博ID | |
| attitude_type | No | 点赞类型: 0=全部, 1=点赞, 2=开心, 3=惊讶, 4=伤心, 5=愤怒, 6=打赏, 8=抱抱 |
tikhub_get_api_v1_weibo_app_fetch_status_repostsGet post repostsInspect
Get post reposts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| max_id | No | 翻页游标 | |
| status_id | Yes | 微博ID |
tikhub_get_api_v1_weibo_app_fetch_user_albumGet user albumInspect
Get user album Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| since_id | No | 翻页游标 |
tikhub_get_api_v1_weibo_app_fetch_user_articlesGet user articlesInspect
Get user articles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| since_id | No | 翻页游标 |
tikhub_get_api_v1_weibo_app_fetch_user_audiosGet user audiosInspect
Get user audios Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| since_id | No | 翻页游标 |
tikhub_get_api_v1_weibo_app_fetch_user_followersGet user followersInspect
Get user followers Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| page | No | 页码,从1开始 |
tikhub_get_api_v1_weibo_app_fetch_user_followingGet user followingInspect
Get user following Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| since_id | No | 翻页游标,格式为"时间戳|偏移量",首次请求不传,后续请求使用返回的since_id值 | |
| sort_type | No | 排序类型: 1=按最新微博时间排序, 2=按关注时间排序(默认) |
tikhub_get_api_v1_weibo_app_fetch_user_infoGet user informationInspect
Get user information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID |
tikhub_get_api_v1_weibo_app_fetch_user_info_detailGet user detail informationInspect
Get user detail information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID |
tikhub_get_api_v1_weibo_app_fetch_user_profile_feedGet user profile feedInspect
Get user profile feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| since_id | No | 翻页游标 |
tikhub_get_api_v1_weibo_app_fetch_user_super_topicsGet user super topicsInspect
Get user super topics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| page | No | 页码 |
tikhub_get_api_v1_weibo_app_fetch_user_timelineGet user timelineInspect
Get user timeline Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| page | No | 页码 | |
| month | No | 时间筛选(YYYYMMDD格式) | |
| filter_type | No | 筛选类型 |
tikhub_get_api_v1_weibo_app_fetch_user_videosGet user videosInspect
Get user videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID | |
| since_id | No | 翻页游标 |
tikhub_get_api_v1_weibo_app_fetch_video_detailGet video detailInspect
Get video detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mid | Yes | 视频微博ID |
tikhub_get_api_v1_weibo_app_fetch_video_featured_feedGet video featured feedInspect
Get video featured feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,首页不传,第二页传2 |
tikhub_get_api_v1_weibo_web_v2_check_allow_comment_with_picCheck if Weibo allows image commentsInspect
Check if Weibo allows image comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | 微博ID/Weibo ID |
tikhub_get_api_v1_weibo_web_v2_fetch_advanced_searchWeibo Advanced SearchInspect
Weibo Advanced Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | 搜索关键词/Search keyword | |
| page | No | 页码/Page number | |
| timescope | No | 时间范围/Time scope (custom:start:end) | |
| search_type | No | search_type | |
| include_type | No | 包含类型/Include type: all(全部), pic(含图片), video(含视频), music(含音乐), link(含短链) |
tikhub_get_api_v1_weibo_web_v2_fetch_ai_searchWeibo AI SearchInspect
Weibo AI Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_weibo_web_v2_fetch_all_groupsGet all groups informationInspect
Get all groups information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_web_v2_fetch_city_listRegion City ListInspect
Region City List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| normalized | No | 是否返回标准化结构(省份列表+城市数组)/Whether to return normalized structure |
tikhub_get_api_v1_weibo_web_v2_fetch_entertainment_rankingGet Weibo entertainment rankingInspect
Get Weibo entertainment ranking Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_web_v2_fetch_hot_ranking_timelineGet hot ranking timelineInspect
Get hot ranking timeline Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 获取数量,默认10/Count, default is 10 | |
| max_id | No | 最大ID,默认为0/Max ID, default is 0 | |
| since_id | No | 分页标识,默认为0/Pagination identifier, default is 0 | |
| ranking_type | Yes | 榜单类型:hour=小时榜,yesterday=昨日榜,day_before=前日榜,week=周榜,male=男榜,female=女榜/Ranking type: hour=hourly, yesterday=yesterday, day_before=day before, week=weekly, male=male ranking, female=female ranking |
tikhub_get_api_v1_weibo_web_v2_fetch_hot_searchGet Weibo hot search rankingInspect
Get Weibo hot search ranking Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_web_v2_fetch_hot_search_indexGet Weibo hot search index (10 items)Inspect
Get Weibo hot search index (10 items) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_web_v2_fetch_hot_search_summaryGet Weibo complete hot search ranking (50 items)Inspect
Get Weibo complete hot search ranking (50 items) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_web_v2_fetch_life_rankingGet Weibo life rankingInspect
Get Weibo life ranking Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_web_v2_fetch_pic_searchWeibo picture searchInspect
Weibo picture search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| query | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_weibo_web_v2_fetch_post_commentsGet Weibo commentsInspect
Get Weibo comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | 微博ID/Weibo ID | |
| count | No | 评论数量/Number of comments | |
| max_id | No | 页码/Page number |
tikhub_get_api_v1_weibo_web_v2_fetch_post_detailGet single post dataInspect
Get single post data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | 作品id/Post id | |
| is_get_long_text | No | 是否获取长微博全文/Whether to get the full text of long Weibo posts (true/false) |
tikhub_get_api_v1_weibo_web_v2_fetch_post_sub_commentsGet Weibo sub-commentsInspect
Get Weibo sub-comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | 主评论ID/Comment ID | |
| count | No | 子评论数量/Number of sub-comments | |
| max_id | No | 分页标识/Page identifier |
tikhub_get_api_v1_weibo_web_v2_fetch_realtime_searchWeibo Realtime SearchInspect
Weibo Realtime Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| query | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_weibo_web_v2_fetch_similar_searchGet Weibo similar search recommendationsInspect
Get Weibo similar search recommendations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_weibo_web_v2_fetch_social_rankingGet Weibo social rankingInspect
Get Weibo social ranking Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_weibo_web_v2_fetch_topic_searchWeibo topic searchInspect
Weibo topic search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| query | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_weibo_web_v2_fetch_user_basic_infoGet user basic informationInspect
Get user basic information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户id/User id |
tikhub_get_api_v1_weibo_web_v2_fetch_user_fansGet user fans listInspect
Get user fans list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID/User ID | |
| page | No | 页码/Page number |
tikhub_get_api_v1_weibo_web_v2_fetch_user_followingGet user following listInspect
Get user following list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID/User ID | |
| page | No | 页码/Page number |
tikhub_get_api_v1_weibo_web_v2_fetch_user_infoGet user informationInspect
Get user information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | No | 用户id/User id | |
| custom | No | 自定义微博用户名/Custom Weibo username |
tikhub_get_api_v1_weibo_web_v2_fetch_user_original_postsGet Weibo user original postsInspect
Get Weibo user original posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户id/User id | |
| page | No | 页数/Page number | |
| since_id | No | 翻页标识,用于获取下一页数据/Pagination identifier for getting next page data |
tikhub_get_api_v1_weibo_web_v2_fetch_user_postsGet Weibo user postsInspect
Get Weibo user posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户id/User id | |
| page | No | 页数/Page number | |
| feature | No | 特征值,控制返回数据的数量和字段:0=返回10条基础数据,1=返回20条扩展数据,2=返回20条图片相关数据,3=返回20条视频相关数据,字段逐级增加/Feature type: 0=10 basic posts, 1=20 extended posts, 2=20 image-related posts, 3=20 video-related posts, fields increase progressively | |
| since_id | No | 翻页标识,用于获取下一页数据/Pagination identifier for getting next page data |
tikhub_get_api_v1_weibo_web_v2_fetch_user_recommend_timelineGet user recommend timelineInspect
Get user recommend timeline Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 获取数量/Count | |
| max_id | No | 最大ID/Max ID | |
| refresh | No | 刷新类型,0=正常刷新,1=强制刷新/Refresh type, 0=normal refresh, 1=force refresh | |
| extparam | No | 扩展参数/Extended parameters | |
| group_id | No | 分组ID/Group ID | |
| containerid | No | 容器ID/Container ID |
tikhub_get_api_v1_weibo_web_v2_fetch_user_searchUser searchInspect
User search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| age | No | 年龄段 18y/22y/29y/39y/40y / Age bucket | |
| tag | No | 标签筛选/Tag filter | |
| auth | No | auth | |
| page | No | 页码/Page | |
| work | No | 公司筛选/Company filter | |
| query | No | 搜索关键词/Query(提供则视为“全部”搜索;留空则仅应用高级筛选参数) | |
| gender | No | 性别 man / women / Gender | |
| region | No | 地区编码,从 /city_list 获取/Region code from /city_list | |
| school | No | 学校筛选/School filter | |
| nickname | No | 昵称筛选/Nickname filter |
tikhub_get_api_v1_weibo_web_v2_fetch_user_video_collection_detaiGet user video collection detailInspect
Get user video collection detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cid | Yes | 收藏夹ID/Collection ID | |
| cursor | No | 分页游标/Pagination cursor | |
| tab_code | No | 排序方式:0=默认,1=最热,2=最新/Sort type: 0=default, 1=hottest, 2=latest |
tikhub_get_api_v1_weibo_web_v2_fetch_user_video_collection_listGet user video collection listInspect
Get user video collection list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID/User ID |
tikhub_get_api_v1_weibo_web_v2_fetch_user_video_listGet user all videosInspect
Get user all videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | 用户ID/User ID | |
| cursor | No | 分页游标/Pagination cursor |
tikhub_get_api_v1_weibo_web_v2_fetch_video_search视频搜索(热门/全部)/Weibo video search (hot/all)Inspect
视频搜索(热门/全部)/Weibo video search (hot/all) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | 搜索模式:hot=热门 / all=全部 | |
| page | No | 页码/Page number | |
| query | Yes | 搜索关键词/Search keyword |
tikhub_get_api_v1_weibo_web_v2_search_user_postsSearch user postsInspect
Search user posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | 搜索关键词/Search keyword | |
| uid | Yes | 用户ID/User ID | |
| page | No | 页数/Page number | |
| hasori | No | 是否包含原创微博,1=包含,0=不包含/Include original posts, 1=include, 0=exclude | |
| haspic | No | 是否包含图片微博,1=包含,0=不包含/Include image posts, 1=include, 0=exclude | |
| hasret | No | 是否包含转发微博,1=包含,0=不包含/Include retweets, 1=include, 0=exclude | |
| endtime | No | 结束时间戳/End timestamp | |
| hastext | No | 是否包含文字微博,1=包含,0=不包含/Include text posts, 1=include, 0=exclude | |
| hasmusic | No | 是否包含音乐微博,1=包含,0=不包含/Include music posts, 1=include, 0=exclude | |
| hasvideo | No | 是否包含视频微博,1=包含,0=不包含/Include video posts, 1=include, 0=exclude | |
| starttime | No | 开始时间戳/Start timestamp |
tikhub_get_api_v1_xiaohongshu_app_v2_get_creator_hot_inspirationGet creator hot inspiration feedInspect
Get creator hot inspiration feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request |
tikhub_get_api_v1_xiaohongshu_app_v2_get_creator_inspiration_feeGet creator inspiration feedInspect
Get creator inspiration feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tab | No | 标签类型/Tab type | |
| cursor | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | |
| source | No | 来源/Source |
tikhub_get_api_v1_xiaohongshu_app_v2_get_image_note_detailGet image note detailInspect
Get image note detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | No | 笔记ID/Note ID | |
| share_text | No | 分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |
tikhub_get_api_v1_xiaohongshu_app_v2_get_note_commentsGet note commentsInspect
Get note comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | 评论索引,首次请求传0/Comment index, pass 0 for first request | |
| cursor | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | |
| note_id | No | 笔记ID/Note ID | |
| pageArea | No | 折叠状态: UNFOLDED(默认-展开), FOLDED(折叠) | |
| share_text | No | 分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn | |
| sort_strategy | No | 排序策略/Sort strategy: default, latest_v2, like_count |
tikhub_get_api_v1_xiaohongshu_app_v2_get_note_sub_commentsGet note sub commentsInspect
Get note sub comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | 分页索引,首次传1,翻页时从$.data.data.cursor中提取index值/Pagination index, pass 1 for first request, extract index from $.data.data.cursor for next page | |
| cursor | No | 分页游标,首次留空,翻页时从$.data.data.cursor中提取cursor值/Pagination cursor, leave empty for first request, extract cursor from $.data.data.cursor for next page | |
| note_id | No | 笔记ID/Note ID | |
| comment_id | Yes | 父评论ID/Parent comment ID | |
| share_text | No | 分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_detailGet product detailInspect
Get product detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sku_id | Yes | 商品SKU ID/Product SKU ID | |
| source | No | 来源/Source | |
| pre_page | No | 前置页面/Previous page |
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_recommendationsGet product recommendationsInspect
Get product recommendations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区/Region | |
| sku_id | Yes | 商品SKU ID/Product SKU ID | |
| cursor_score | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request |
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_review_overviewGet product review overviewInspect
Get product review overview Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tab | No | 标签类型/Tab type | |
| sku_id | Yes | 商品SKU ID/Product SKU ID |
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_reviewsGet product reviewsInspect
Get product reviews Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,从0开始/Page number, start from 0 | |
| sku_id | Yes | 商品SKU ID/Product SKU ID | |
| from_page | No | 来源页面/From page | |
| share_pics_only | No | 仅看有图评论:0=否, 1=是/Show reviews with images only: 0=no, 1=yes | |
| sort_strategy_type | No | 排序策略:0=综合排序, 1=最新排序/Sort strategy: 0=general, 1=latest |
tikhub_get_api_v1_xiaohongshu_app_v2_get_topic_feedGet topic feedInspect
Get topic feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序方式/Sort: trend(最热), time(最新) | |
| source | No | 来源/Source | |
| page_id | Yes | 话题页面ID/Topic page ID | |
| session_id | No | 会话ID,翻页时保持一致/Session ID, keep consistent for pagination | |
| cursor_score | No | 分页游标分数,翻页时传入/Pagination cursor score for next page | |
| last_note_ct | No | 上一页最后一条笔记创建时间,翻页时传入/Last note create time from previous page | |
| last_note_id | No | 上一页最后一条笔记ID,翻页时传入/Last note ID from previous page | |
| first_load_time | No | 首次加载时间戳,翻页时保持一致/First load timestamp, keep consistent for pagination |
tikhub_get_api_v1_xiaohongshu_app_v2_get_topic_infoGet topic infoInspect
Get topic info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| source | No | 来源/Source | |
| note_id | No | 来源笔记ID,从笔记跳转到话题时传入/Source note ID, pass when jumping from note to topic | |
| page_id | Yes | 话题页面ID/Topic page ID |
tikhub_get_api_v1_xiaohongshu_app_v2_get_user_faved_notesGet user faved notesInspect
Get user faved notes Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 分页游标,首次请求留空,翻页时传入上一页最后一条笔记的note_id/Pagination cursor, leave empty for first request, pass last note_id from previous page for next page | |
| user_id | No | 用户ID/User ID | |
| share_text | No | 分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |
tikhub_get_api_v1_xiaohongshu_app_v2_get_user_infoGet user infoInspect
Get user info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | 用户ID/User ID | |
| share_text | No | 分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |
tikhub_get_api_v1_xiaohongshu_app_v2_get_user_posted_notesGet user posted notesInspect
Get user posted notes Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 分页游标,首次请求留空/Pagination cursor, leave empty for first request | |
| user_id | No | 用户ID/User ID | |
| share_text | No | 分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |
tikhub_get_api_v1_xiaohongshu_app_v2_get_video_note_detailGet video note detailInspect
Get video note detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | No | 笔记ID/Note ID | |
| share_text | No | 分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |
tikhub_get_api_v1_xiaohongshu_app_v2_search_groupsSearch groupsInspect
Search groups Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| source | No | 来源/Source | |
| keyword | Yes | 搜索关键词/Search keyword | |
| page_no | No | 页码,从0开始/Page number, start from 0 | |
| search_id | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | |
| is_recommend | No | 是否推荐:0=否, 1=是/Is recommend: 0=no, 1=yes |
tikhub_get_api_v1_xiaohongshu_app_v2_search_imagesSearch imagesInspect
Search images Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,从1开始/Page number, start from 1 | |
| source | No | 来源/Source | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | |
| word_request_id | No | 词请求ID,翻页时传入首次搜索返回的值/Word request ID for pagination | |
| search_session_id | No | 搜索会话ID,翻页时传入首次搜索返回的值/Search session ID for pagination |
tikhub_get_api_v1_xiaohongshu_app_v2_search_notesSearch notesInspect
Search notes Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,从1开始/Page number, start from 1 | |
| source | No | 来源/Source | |
| ai_mode | No | AI模式:0=关闭, 1=开启/AI mode: 0=off, 1=on | |
| keyword | Yes | 搜索关键词/Search keyword | |
| note_type | No | 笔记类型/Note type: 不限, 视频笔记, 普通笔记, 直播笔记 | |
| search_id | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination | |
| sort_type | No | 排序方式/Sort type | |
| time_filter | No | 发布时间筛选/Time filter: 不限, 一天内, 一周内, 半年内 | |
| search_session_id | No | 搜索会话ID,翻页时传入首次搜索返回的值/Search session ID for pagination |
tikhub_get_api_v1_xiaohongshu_app_v2_search_productsSearch productsInspect
Search products Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,从1开始/Page number, start from 1 | |
| source | No | 来源/Source | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination |
tikhub_get_api_v1_xiaohongshu_app_v2_search_usersSearch usersInspect
Search users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,从1开始/Page number, start from 1 | |
| source | No | 来源/Source | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索ID,翻页时传入首次搜索返回的值/Search ID for pagination |
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_homefeedFetch homepage feedInspect
Fetch homepage feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| num | No | 返回数量,最大40/Number of results, max 40 | |
| category | No | 分类频道ID/Category channel ID | |
| cursor_score | No | 翻页游标/Pagination cursor | |
| need_filter_image | No | 仅图文/Image notes only |
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_homefeed_categoriesFetch homepage categoriesInspect
Fetch homepage categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_note_detailFetch note detailInspect
Fetch note detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | 笔记ID/Note ID | |
| xsec_token | Yes | 安全令牌,可以从小红书的分享链接中获取/Security token, can be obtained from the sharing link of Xiaohongshu |
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_search_suggestFetch search suggestionsInspect
Fetch search suggestions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 关键词 (可为空)/Keyword (optional) |
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_user_infoFetch user infoInspect
Fetch user info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户ID/User ID |
tikhub_get_api_v1_xigua_app_v2_fetch_one_videoGet single video dataInspect
Get single video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品id/Video id |
tikhub_get_api_v1_xigua_app_v2_fetch_one_video_play_urlGet single video play URLInspect
Get single video play URL Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品id/Video id |
tikhub_get_api_v1_xigua_app_v2_fetch_one_video_v2Get single video data V2Inspect
Get single video data V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 作品id/Video id |
tikhub_get_api_v1_xigua_app_v2_fetch_user_infoPersonal informationInspect
Personal information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户id/User id |
tikhub_get_api_v1_xigua_app_v2_fetch_user_post_listGet user post listInspect
Get user post list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 用户id/User id | |
| max_behot_time | No | 最大行为时间/Maximum behavior time |
tikhub_get_api_v1_xigua_app_v2_fetch_video_comment_listVideo comment listInspect
Video comment list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Count | |
| offset | No | 偏移量/Offset | |
| item_id | Yes | 作品id/Video id |
tikhub_get_api_v1_xigua_app_v2_search_videoSearch videoInspect
Search video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 偏移量/Offset | |
| keyword | Yes | 关键词/Keyword | |
| order_type | No | 排序方式/Order type | |
| max_duration | No | 最大时长/Maximum duration | |
| min_duration | No | 最小时长/Minimum duration |
tikhub_get_api_v1_youtube_web_get_channel_idGet channel IDInspect
Get channel ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_name | Yes | 频道名称/Channel name |
tikhub_get_api_v1_youtube_web_get_channel_id_v2Get channel ID from URL V2Inspect
Get channel ID from URL V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_url | Yes | 频道URL/Channel URL,支持多种格式如:https://www.youtube.com/@username, https://www.youtube.com/channel/UCxxxxxx, https://www.youtube.com/c/channelname |
tikhub_get_api_v1_youtube_web_get_channel_infoGet channel informationInspect
Get channel information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | Yes | 频道ID/Channel ID |
tikhub_get_api_v1_youtube_web_get_channel_short_videosGet channel short videosInspect
Get channel short videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | Yes | 频道ID/Channel ID | |
| continuation_token | No | 翻页令牌/Pagination token |
tikhub_get_api_v1_youtube_web_get_channel_urlGet channel URL from channel IDInspect
Get channel URL from channel ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | Yes | 频道ID/Channel ID (格式如:UCeu6U67OzJhV1KwBansH3Dg) |
tikhub_get_api_v1_youtube_web_get_relate_videoGet related videosInspect
Get related videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| video_id | Yes | 视频ID/Video ID | |
| continuation_token | No | 翻页令牌/Pagination token |
tikhub_get_api_v1_youtube_web_search_channelSearch channelInspect
Search channel Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | Yes | 频道ID/Channel ID | |
| country_code | No | 国家代码/Country code | |
| search_query | Yes | 搜索关键字/Search keyword | |
| language_code | No | 语言代码/Language code | |
| continuation_token | No | 翻页令牌/Pagination token |
tikhub_get_api_v1_youtube_web_search_videoSearch videoInspect
Search video Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| order_by | No | 排序方式/Order by | |
| country_code | No | 国家代码/Country code | |
| search_query | Yes | 搜索关键字/Search keyword | |
| language_code | No | 语言代码/Language code | |
| continuation_token | No | 翻页令牌/Pagination token |
tikhub_get_api_v1_youtube_web_v2_get_channel_community_postsGet channel community postsInspect
Get channel community posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | Yes | 频道ID/Channel ID | |
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | No | 分页token,用于获取下一页/Pagination token for next page |
tikhub_get_api_v1_youtube_web_v2_get_channel_descriptionGet channel descriptionInspect
Get channel description Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | No | 频道ID(格式如:UCeu6U67OzJhV1KwBansH3Dg),可通过get_channel_id接口从频道URL获取/Channel ID, can be obtained from channel URL via get_channel_id endpoint | |
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | No | 翻页标志(用于获取频道注册时间等高级信息)/Continuation token for getting advanced info like channel creation date |
tikhub_get_api_v1_youtube_web_v2_get_channel_idGet channel ID from URLInspect
Get channel ID from URL Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_url | Yes | 频道URL/Channel URL,支持多种格式如:https://www.youtube.com/@username, https://www.youtube.com/channel/UCxxxxxx, https://www.youtube.com/c/channelname |
tikhub_get_api_v1_youtube_web_v2_get_channel_shortsGet channel shortsInspect
Get channel shorts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | No | 频道ID/Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw) | |
| channel_url | No | 频道URL/Channel URL (如果提供channel_id则忽略/Ignored if channel_id is provided) | |
| need_format | No | 是否格式化数据/Whether to format data | |
| continuation_token | No | 分页token/Pagination token |
tikhub_get_api_v1_youtube_web_v2_get_channel_urlGet channel URL from channel IDInspect
Get channel URL from channel ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | Yes | 频道ID/Channel ID (格式如:UCeu6U67OzJhV1KwBansH3Dg) |
tikhub_get_api_v1_youtube_web_v2_get_channel_videosGet channel videosInspect
Get channel videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| channel_id | Yes | 频道ID/Channel ID | |
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | No | 分页token,用于获取下一页/Pagination token for next page |
tikhub_get_api_v1_youtube_web_v2_get_general_searchGeneral search (raw data, recommend V2)Inspect
General search (raw data, recommend V2) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| feature | No | 特征过滤 | Feature filter | |
| sort_by | No | 排序方式 | Sort by | |
| duration | No | 视频时长过滤 | Duration filter | |
| time_zone | No | 时区(如America/Los_Angeles, Asia/Shanghai等)/Time zone | |
| upload_time | No | 上传时间过滤 | Upload time filter | |
| content_type | No | 内容类型过滤 | Content type filter | |
| country_code | No | 国家代码(如US, CN等)/Country code | |
| search_query | Yes | 搜索关键字/Search keyword | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | No | 翻页令牌/Pagination token |
tikhub_get_api_v1_youtube_web_v2_get_general_search_v2General search V2Inspect
General search V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | 类型过滤/Type filter | |
| keyword | No | 搜索关键词(首次请求必填)/Search keyword (required for first request) | |
| sort_by | No | 排序方式/Sort by | |
| duration | No | 时长过滤/Duration filter: short (<4min), medium (4-20min), long (>20min) | |
| features | No | 特性过滤(逗号分隔)/Feature filter (comma separated): live, 4k, hd, subtitles, creative_commons, 360, vr180, 3d, hdr | |
| upload_date | No | 上传时间过滤/Upload date filter | |
| continuation_token | No | 分页token,用于获取下一页/Continuation token for next page |
tikhub_get_api_v1_youtube_web_v2_get_post_comment_repliesGet post comment repliesInspect
Get post comment replies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | Yes | 回复的continuation token(从帖子评论的 reply_continuation_token 字段获取)/Reply continuation token from post comment |
tikhub_get_api_v1_youtube_web_v2_get_post_commentsGet post commentsInspect
Get post comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | No | 帖子ID(首次请求时必填)/Post ID (required for first request) | |
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | No | 分页token(分页时必填,也可用 get_post_detail 返回的 comments_continuation_token)/Pagination token |
tikhub_get_api_v1_youtube_web_v2_get_post_detailGet post detailInspect
Get post detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | Yes | 帖子ID/Post ID | |
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code |
tikhub_get_api_v1_youtube_web_v2_get_search_suggestionsGet search suggestionsInspect
Get search suggestions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区代码/Region code (e.g., US, SG, CN, JP) | |
| keyword | Yes | 搜索关键词/Search keyword | |
| language | No | 语言代码/Language code (e.g., en, zh-cn, ja) |
tikhub_get_api_v1_youtube_web_v2_get_shorts_searchShorts search (raw data, recommend V2)Inspect
Shorts search (raw data, recommend V2) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort_by | No | 排序方式 | Sort by for Shorts | |
| time_zone | No | 时区(如America/Los_Angeles, Asia/Shanghai等)/Time zone | |
| upload_time | No | 上传时间过滤 | Upload time filter for Shorts | |
| country_code | No | 国家代码(如US, CN等)/Country code | |
| search_query | Yes | 搜索关键字/Search keyword | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | No | 翻页令牌/Pagination token | |
| filter_mixed_content | No | 是否过滤混合内容(长视频),默认True / Filter mixed content (long videos), default True |
tikhub_get_api_v1_youtube_web_v2_get_shorts_search_v2Shorts search V2Inspect
Shorts search V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 搜索关键词(首次请求必填)/Search keyword (required for first request) | |
| sort_by | No | 排序方式/Sort by | |
| upload_date | No | 上传时间过滤/Upload date filter | |
| continuation_token | No | 分页token,用于获取下一页/Continuation token for next page |
tikhub_get_api_v1_youtube_web_v2_get_signed_stream_urlGet signed video stream URLInspect
Get signed video stream URL Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itag | Yes | 格式标识符 itag (从 get_video_streams 接口获取)/Format identifier itag (obtained from get_video_streams endpoint) | |
| video_id | No | 视频ID/Video ID | |
| video_url | No | 视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided) |
tikhub_get_api_v1_youtube_web_v2_get_video_captionsGet video captionsInspect
Get video captions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | 字幕格式/Caption format | |
| video_id | No | 视频ID/Video ID | |
| video_url | No | 视频URL/Video URL | |
| language_code | No | 语言代码,为空时返回可用字幕列表/Language code, returns available caption list if empty |
tikhub_get_api_v1_youtube_web_v2_get_video_captions_resultGet video captions async job resultInspect
Get video captions async job result Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | 字幕格式/Caption format | |
| job_id | Yes | 异步任务ID/Async job ID |
tikhub_get_api_v1_youtube_web_v2_get_video_comment_repliesGet video sub commentsInspect
Get video sub comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | Yes | 回复的continuation token(从一级评论的reply_continuation_token字段获取)/Reply continuation token from first-level comment |
tikhub_get_api_v1_youtube_web_v2_get_video_commentsGet video commentsInspect
Get video comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort_by | No | 排序方式 | Sort by | |
| video_id | Yes | 视频ID/Video ID | |
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| country_code | No | 国家代码(如US, JP等)/Country code | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code | |
| continuation_token | No | 翻页令牌/Pagination token |
tikhub_get_api_v1_youtube_web_v2_get_video_infoGet video informationInspect
Get video information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| video_id | Yes | 视频ID/Video ID | |
| need_format | No | 是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data | |
| language_code | No | 语言代码(如zh-CN, en-US等)/Language code |
tikhub_get_api_v1_youtube_web_v2_get_video_info_v2Get video information V2Inspect
Get video information V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| video_id | No | 视频ID/Video ID | |
| video_url | No | 视频URL/Video URL (如果提供 video_id 则忽略此参数) | |
| need_format | No | 是否需要清洗数据,提取关键字段/Whether to return cleaned payload |
tikhub_get_api_v1_youtube_web_v2_get_video_streamsGet video streams infoInspect
Get video streams info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| video_id | No | 视频ID/Video ID | |
| video_url | No | 视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided) |
tikhub_get_api_v1_youtube_web_v2_get_video_streams_v2Get video streams info V2Inspect
Get video streams info V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| video_id | No | 视频ID/Video ID | |
| video_url | No | 视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided) |
tikhub_get_api_v1_youtube_web_v2_search_channelsSearch channelsInspect
Search channels Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 搜索关键词/Search keyword | |
| need_format | No | 是否格式化数据/Whether to format data | |
| continuation_token | No | 分页token/Pagination token |
tikhub_get_api_v1_zhihu_web_fetch_ai_search_streamGet Zhihu AI Search (v2)Inspect
Get Zhihu AI Search (v2) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chat_mode | No | 对话模式/Chat mode | |
| session_id | No | 会话ID/Session ID | |
| message_content | Yes | 搜索内容/Search Content |
tikhub_get_api_v1_zhihu_web_fetch_answer_detailGet Zhihu Answer DetailInspect
Get Zhihu Answer Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| answer_id | Yes | 回答ID/Answer ID |
tikhub_get_api_v1_zhihu_web_fetch_article_search_v3Get Zhihu Article Search V3Inspect
Get Zhihu Article Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | 排序/Sort | |
| limit | No | 每页文章数量/Number of articles per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords | |
| vertical | No | 垂类/Vertical Type | |
| search_source | No | 搜索来源/Search Source | |
| time_interval | No | 时间间隔/Time Interval | |
| vertical_info | No | 垂类信息/Vertical Info | |
| search_hash_id | No | 搜索哈希ID/Search Hash ID | |
| show_all_topics | No | 显示所有主题/Show all topics |
tikhub_get_api_v1_zhihu_web_fetch_column_article_detailGet Zhihu Column Article DetailInspect
Get Zhihu Column Article Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| article_id | Yes | 文章ID/Article ID |
tikhub_get_api_v1_zhihu_web_fetch_column_articlesGet Zhihu Column ArticlesInspect
Get Zhihu Column Articles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页文章数量/Number of articles per page | |
| offset | No | 偏移量/Offset | |
| column_id | Yes | 专栏ID/Column ID |
tikhub_get_api_v1_zhihu_web_fetch_column_comment_configGet Zhihu Column Comment ConfigInspect
Get Zhihu Column Comment Config Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| article_id | Yes | 文章ID/Article ID |
tikhub_get_api_v1_zhihu_web_fetch_column_recommendGet Zhihu Similar Column RecommendInspect
Get Zhihu Similar Column Recommend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页专栏数量/Number of columns per page | |
| offset | No | 偏移量/Offset | |
| article_id | Yes | 文章ID/Article ID |
tikhub_get_api_v1_zhihu_web_fetch_column_relationshipGet Zhihu Column Article RelationshipInspect
Get Zhihu Column Article Relationship Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| article_id | Yes | 文章ID/Article ID |
tikhub_get_api_v1_zhihu_web_fetch_column_search_v3Get Zhihu Column Search V3Inspect
Get Zhihu Column Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页专栏数量/Number of columns per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords | |
| search_hash_id | No | 搜索哈希ID/Search Hash ID |
tikhub_get_api_v1_zhihu_web_fetch_comment_v5Get Zhihu Comment V5Inspect
Get Zhihu Comment V5 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页评论数量/Number of comments per page | |
| offset | No | 偏移量/Offset | |
| order_by | No | 排序/Sort | |
| answer_id | Yes | 回答ID/Answer ID |
tikhub_get_api_v1_zhihu_web_fetch_ebook_search_v3Get Zhihu Ebook Search V3Inspect
Get Zhihu Ebook Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页电子书数量/Number of ebooks per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords | |
| search_hash_id | No | 搜索哈希ID/Search Hash ID |
tikhub_get_api_v1_zhihu_web_fetch_hot_listGet Zhihu Hot ListInspect
Get Zhihu Hot List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页文章数量/Number of articles per page | |
| desktop | No | 是否为桌面端/Is it a desktop |
tikhub_get_api_v1_zhihu_web_fetch_hot_recommendGet Zhihu Hot RecommendInspect
Get Zhihu Hot Recommend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | 偏移量/Offset | |
| page_number | No | 页码/Page Number | |
| session_token | No | 会话令牌/Session Token |
tikhub_get_api_v1_zhihu_web_fetch_pin_commentsGet Zhihu Pin CommentsInspect
Get Zhihu Pin Comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页评论数量/Number of comments per page | |
| offset | No | 偏移量,翻页用返回里的游标/Offset from response cursor | |
| pin_id | Yes | 想法ID/Pin ID | |
| order_by | No | 排序方式:score=默认,ts=最新/Sort: score=default, ts=newest |
tikhub_get_api_v1_zhihu_web_fetch_pin_detailGet Zhihu Pin DetailInspect
Get Zhihu Pin Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| pin_id | Yes | 想法ID/Pin ID |
tikhub_get_api_v1_zhihu_web_fetch_preset_searchGet Zhihu Preset SearchInspect
Get Zhihu Preset Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_zhihu_web_fetch_question_answersGet Zhihu Question AnswersInspect
Get Zhihu Question Answers Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页回答数量/Number of answers per page | |
| order | No | 排序方式:default=默认排序,updated=按时间排序/Sort order: default=default sort, updated=sort by time | |
| cursor | No | 分页游标/Pagination cursor | |
| offset | No | 偏移量/Offset | |
| session_id | No | 会话ID/Session ID | |
| question_id | Yes | 问题ID/Question ID |
tikhub_get_api_v1_zhihu_web_fetch_question_detailGet Zhihu Question DetailInspect
Get Zhihu Question Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| question_id | Yes | 问题ID/Question ID |
tikhub_get_api_v1_zhihu_web_fetch_recommend_followeesGet Zhihu Recommend FolloweesInspect
Get Zhihu Recommend Followees Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_zhihu_web_fetch_salt_search_v3Get Zhihu Salt Search V3Inspect
Get Zhihu Salt Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页内容数量/Number of contents per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords | |
| search_hash_id | No | 搜索哈希ID/Search Hash ID |
tikhub_get_api_v1_zhihu_web_fetch_search_recommendGet Zhihu Search RecommendInspect
Get Zhihu Search Recommend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_get_api_v1_zhihu_web_fetch_search_suggestGet Zhihu Search SuggestInspect
Get Zhihu Search Suggest Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 搜索关键词/Search Keywords |
tikhub_get_api_v1_zhihu_web_fetch_sub_comment_v5Get Zhihu Sub Comment V5Inspect
Get Zhihu Sub Comment V5 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页评论数量/Number of comments per page | |
| offset | No | 偏移量/Offset | |
| order_by | No | 排序/Sort | |
| comment_id | Yes | 评论ID/Comment ID |
tikhub_get_api_v1_zhihu_web_fetch_topic_search_v3Get Zhihu Topic Search V3Inspect
Get Zhihu Topic Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页话题数量/Number of topics per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords |
tikhub_get_api_v1_zhihu_web_fetch_user_answersGet Zhihu User AnswersInspect
Get Zhihu User Answers Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页回答数量/Number of answers per page | |
| offset | No | 偏移量/Offset | |
| sort_type | No | 排序类型/Sort Type | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_articlesGet Zhihu User ArticlesInspect
Get Zhihu User Articles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页文章数量/Number of articles per page | |
| offset | No | 偏移量/Offset | |
| sort_type | No | 排序类型/Sort Type | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_collectionsGet Zhihu User Created CollectionsInspect
Get Zhihu User Created Collections Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页收藏夹数量/Number of collections per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_follow_collectionsGet Zhihu User Follow CollectionsInspect
Get Zhihu User Follow Collections Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页收藏数量/Number of collections per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_follow_columnsGet Zhihu User ColumnsInspect
Get Zhihu User Columns Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页专栏数量/Number of columns per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_followeesGet Zhihu User FollowingInspect
Get Zhihu User Following Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页用户数量/Number of users per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_followersGet Zhihu User FollowersInspect
Get Zhihu User Followers Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页用户数量/Number of users per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_follow_questionsGet Zhihu User Follow QuestionsInspect
Get Zhihu User Follow Questions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页问题数量/Number of questions per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_follow_topicsGet Zhihu User Follow TopicsInspect
Get Zhihu User Follow Topics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页话题数量/Number of topics per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_included_articlesGet Zhihu User Included ArticlesInspect
Get Zhihu User Included Articles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页文章数量/Number of articles per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_infoGet Zhihu User InfoInspect
Get Zhihu User Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_pinsGet Zhihu User PinsInspect
Get Zhihu User Pins Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页想法数量/Number of pins per page | |
| offset | No | 偏移量/Offset | |
| user_url_token | Yes | 用户ID/User ID |
tikhub_get_api_v1_zhihu_web_fetch_user_search_v3Get Zhihu User Search V3Inspect
Get Zhihu User Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页用户数量/Number of users per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords |
tikhub_get_api_v1_zhihu_web_fetch_user_segmentsGet Zhihu User SegmentsInspect
Get Zhihu User Segments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页数量/Number per page | |
| offset | No | 偏移量/Offset | |
| content_type | No | 内容类型/Content type | |
| user_url_token | Yes | 用户 member hash id (非 url_token)/User member hash id (not url_token) |
tikhub_get_api_v1_zhihu_web_fetch_video_listGet Zhihu Video ListInspect
Get Zhihu Video List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页视频数量/Number of videos per page | |
| offset | No | 偏移量/Offset |
tikhub_get_api_v1_zhihu_web_fetch_video_search_v3Get Zhihu Video Search V3Inspect
Get Zhihu Video Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页视频数量/Number of videos per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords | |
| search_hash_id | No | 搜索哈希ID/Search Hash ID |
tikhub_post_api_v1_bilibili_huahuo_search_live_upperSearch live creatorsInspect
Search live creators Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mids | No | 按UID批量精确匹配 | |
| page | No | 页码,从 1 开始,每页固定 20 条 | |
| sort | No | 排序方向:desc 或 asc | |
| gender | No | 主播性别 | |
| order_by | No | 排序字段 | |
| region_id | No | 主播常驻地域(一级) | |
| fans_age_tag | No | 粉丝年龄标签 | |
| max_fans_num | No | 粉丝数上限 | |
| min_fans_num | No | 粉丝数下限 | |
| partition_id | No | 投稿分区(一级) | |
| is_brand_live | No | 直播类型:1=内容直播 0=带货直播。两种类型可用的筛选项不同 | |
| live_good_gmv | No | 近90天GMV档位,0=全部 | |
| live_guild_id | No | 直播公会,取值见 live_guild_drop | |
| max_popularity | No | 近30天场均人气峰值上限 | |
| min_popularity | No | 近30天场均人气峰值下限 | |
| fans_gender_tag | No | 粉丝性别标签 | |
| fans_region_tag | No | 粉丝地域标签 | |
| live_subarea_id | No | 直播分区(二级),取值见 live_area_list | |
| nickname_or_mids | No | 按UP主昵称或UID搜索 | |
| second_region_id | No | 主播常驻地域(二级) | |
| live_good_category | No | 主营类目,0=全部,取值见 live_good_category | |
| high_potential_type | No | 入驻状态 | |
| second_partition_id | No | 投稿分区(二级) | |
| live_danmu_h_avg_30d_max | No | 近30天时均弹幕数上限 | |
| live_danmu_h_avg_30d_min | No | 近30天时均弹幕数下限 | |
| live_audience_h_avg_30d_max | No | 近30天时均观众数上限 | |
| live_audience_h_avg_30d_min | No | 近30天时均观众数下限 |
tikhub_post_api_v1_bilibili_web_fetch_vip_video_playurlGet VIP video playurlInspect
Get VIP video playurl Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cid | Yes | 作品cid/Video cid | |
| bv_id | Yes | 作品id/Video id | |
| cookie | Yes | 大会员用户Cookie/VIP User Cookie |
tikhub_post_api_v1_douyin_app_v3_fetch_multi_videoBatch Get Video Information V1Inspect
Batch Get Video Information V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
tikhub_post_api_v1_douyin_app_v3_fetch_multi_video_high_qualityBatch get the highest quality play URL of videosInspect
Batch get the highest quality play URL of videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 可选,请求出口地区(ISO 国家代码,如 CN/US/HK)。抖音根据请求 IP 返回对应区域 CDN,国内用户传 'CN' 可获得国内 CDN 链接以加快下载速度 / Optional, ISO country code (e.g. CN). Pass 'CN' for users in mainland China to get China-region CDN URLs for faster download. | |
| aweme_ids | No | 作品id列表,用逗号分隔,最多50个/Video id list, separated by commas, up to 50 |
tikhub_post_api_v1_douyin_app_v3_fetch_multi_video_v2Batch Get Video Information V2Inspect
Batch Get Video Information V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
tikhub_post_api_v1_douyin_billboard_fetch_hot_account_listFetch hot account listInspect
Fetch hot account list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page_num | No | 页码,默认1 | |
| page_size | No | 每页数量,默认10 | |
| query_tag | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| date_window | No | 时间窗口(小时),可选 24/72/168,代表近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_calendar_listFetch activity calendarInspect
Fetch activity calendar Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | 快照结束时间 格式10位时间戳 | |
| city_code | No | 城市编码,从城市列表获取,空为全部 | |
| start_date | No | 快照开始时间 格式10位时间戳 | |
| category_code | No | 热点榜分类编码,从热点榜分类获取,空为全部 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_fan_lisFetch high fan rate listInspect
Fetch high fan rate list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| tags | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| keyword | No | 搜索关键词,对榜单按关键词过滤,空为全部 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_like_liFetch high like rate listInspect
Fetch high like rate list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| tags | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| keyword | No | 搜索关键词,对榜单按关键词过滤,空为全部 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_play_liFetch high completion rate listInspect
Fetch high completion rate list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| tags | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| keyword | No | 搜索关键词,对榜单按关键词过滤,空为全部 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_searchFetch search list with rising popularityInspect
Fetch search list with rising popularity Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 搜索关键字 | |
| page_num | No | 页码 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_topic_lFetch topic list with rising popularityInspect
Fetch topic list with rising popularity Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| tags | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| keyword | No | 搜索关键词,对榜单按关键词过滤,空为全部 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_hot_word_lisFetch all hot content wordsInspect
Fetch all hot content words Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 搜索关键字 | |
| page_num | No | 页码 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 24/72/168,代表近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_low_fan_listFetch low fan explosion listInspect
Fetch low fan explosion list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| tags | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| keyword | No | 搜索关键词,对榜单按关键词过滤,空为全部 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_search_listFetch search hot listInspect
Fetch search hot list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 搜索关键字 | |
| page_num | No | 页码 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_topic_listFetch topic hot listInspect
Fetch topic hot list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码 | |
| tags | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| keyword | No | 搜索关键词,对榜单按关键词过滤,空为全部 | |
| page_size | No | 每页数量 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_video_listFetch video hot listInspect
Fetch video hot list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,默认1 | |
| tags | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | |
| keyword | No | 搜索关键词,对榜单按关键词过滤,空为全部 | |
| sub_type | No | 榜单分类,1001 视频总榜 1002 低粉爆款 1003 高完播率 1004 高涨粉率 1005 高点赞率 | |
| page_size | No | 每页数量,默认10 | |
| date_window | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 |
tikhub_post_api_v1_douyin_creator_v2_fetch_author_diagnosisDouyin: fetch author diagnosis (creator_v2)Inspect
Douyin: fetch author diagnosis (creator_v2) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_analysis_involveFetch item analysis involved verticalInspect
Fetch item analysis involved vertical Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| end_date | Yes | 结束日期(格式YYYYMMDD)/End date (format YYYYMMDD) | |
| start_date | Yes | 开始日期(格式YYYYMMDD)/Start date (format YYYYMMDD) |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_analysis_item_peFetch item analysis item performanceInspect
Fetch item analysis item performance Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| genres | No | 体裁类型列表/Genres list: 1=1min以内视频, 2=1-3min视频, 3=3-5min视频, 4=5min+视频, 5=图文, 8=长图文 | |
| end_date | Yes | 结束日期(格式YYYYMMDD)/End date (format YYYYMMDD) | |
| start_date | Yes | 开始日期(格式YYYYMMDD)/Start date (format YYYYMMDD) | |
| metric_type | No | 指标类型/Metric type: 1=播放量(Views), 2=点赞量(Likes), 3=评论量(Comments), 4=分享量(Shares) | |
| primary_verticals | Yes | 垂类标签列表/Primary verticals list (从involved_vertical接口获取) |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_analysis_overvieFetch item analysis overviewInspect
Fetch item analysis overview Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| genres | No | 体裁类型列表/Genres list: 1=1min以内视频, 2=1-3min视频, 3=3-5min视频, 4=5min+视频, 5=图文, 8=长图文 | |
| end_date | Yes | 结束日期(格式YYYYMMDD)/End date (format YYYYMMDD) | |
| start_date | Yes | 开始日期(格式YYYYMMDD)/Start date (format YYYYMMDD) | |
| primary_verticals | Yes | 垂类标签列表/Primary verticals list (从involved_vertical接口获取) |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_audience_othersFetch item audience others analysisInspect
Fetch item audience others analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| item_id | Yes | 作品ID/Item ID |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_audience_portraiFetch item audience portraitInspect
Fetch item audience portrait Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| item_id | Yes | 作品ID/Item ID |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_danmaku_analysisFetch item bullet analysisInspect
Fetch item bullet analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| item_id | Yes | 作品ID/Item ID |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_listDouyin: fetch item list (creator_v2)Inspect
Douyin: fetch item list (creator_v2) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Count per page (最多100条) | |
| cookie | Yes | 用户Cookie/User Cookie | |
| cursor | No | 分页游标/Pagination cursor (可选) | |
| fields | No | 需要返回的字段/Fields to return | |
| end_time | Yes | 结束时间戳(毫秒)/End time timestamp (milliseconds) | |
| order_by | No | 排序方式/Order by (1-26): 1=发布时间↓(新到旧), 2=发布时间↑(旧到新), 3=播放量↓, 4=播放量↑, 5=点赞量↓, 6=点赞量↑, 7=评论量↓, 8=评论量↑, 9=分享量↓, 10=分享量↑, 11=收藏量↓, 12=收藏量↑, 13=2s跳出率↓, 14=2s跳出率↑, 15=5s完播率↓, 16=5s完播率↑, 17=完播率↓, 18=完播率↑, 19=封面点击率↓, 20=封面点击率↑, 21=平均播放时长↓, 22=平均播放时长↑, 23=主页访问量↓, 24=主页访问量↑, 25=粉丝增量↓, 26=粉丝增量↑ | |
| start_time | Yes | 开始时间戳(毫秒)/Start time timestamp (milliseconds) | |
| need_cooperation | No | 是否需要合作信息/Need cooperation info | |
| need_long_article | No | 是否包含长图文/Include long articles |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_list_downloadDouyin: fetch item list download (creator_v2)Inspect
Douyin: fetch item list download (creator_v2) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| max_cursor | Yes | 最大游标(结束时间戳,毫秒)/Max cursor (end timestamp in milliseconds) | |
| min_cursor | Yes | 最小游标(开始时间戳,毫秒)/Min cursor (start timestamp in milliseconds) | |
| type_filters | No | 体裁类型过滤/Type filters: 1=1min以内视频, 2=1-3min视频, 3=3-5min视频, 4=5min+视频, 5=图文, 8=长图文 | |
| need_long_article | No | 是否包含长图文/Include long articles |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_overview_dataFetch item overview dataInspect
Fetch item overview data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | 作品ID列表,多个ID用逗号分隔/Item IDs, separated by comma | |
| cookie | Yes | 用户Cookie/User Cookie | |
| fields | No | 需要返回的字段,多个字段用逗号分隔/Fields to return, separated by comma. 可选值: metrics(指标),review(审核),play_info(播放信息),dou_plus(抖+),integrated_incentive(综合激励),incentive_life(激励生命周期),content_analysis(内容分析) |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_play_sourceFetch item play source statisticsInspect
Fetch item play source statistics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| item_id | Yes | 作品ID/Item ID |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_search_keywordFetch item search keywords statisticsInspect
Fetch item search keywords statistics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| item_id | Yes | 作品ID/Item ID |
tikhub_post_api_v1_douyin_creator_v2_fetch_item_watch_trendFetch item watch trend analysisInspect
Fetch item watch trend analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户Cookie/User Cookie | |
| item_id | Yes | 作品ID/Item ID | |
| analysis_type | No | 分析类型/Analysis type: 1=留存分析(Retention), 2=点赞分析(Like), 7=跳出分析(Bounce) |
tikhub_post_api_v1_douyin_creator_v2_fetch_live_room_history_lisDouyin: fetch live room history list (creator_v2)Inspect
Douyin: fetch live room history list (creator_v2) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页数量限制/Limit per page (最多400条) | |
| cookie | Yes | 用户Cookie/User Cookie | |
| download | No | 是否下载/Download: 0=不下载, 1=下载 | |
| end_date | Yes | 结束日期(格式YYYY-MM-DD)/End date (format YYYY-MM-DD) | |
| start_date | Yes | 开始日期(格式YYYY-MM-DD)/Start date (format YYYY-MM-DD) | |
| need_living | No | 是否包含正在直播的场次/Include living rooms: 0=不包含, 1=包含 |
tikhub_post_api_v1_douyin_douplus_calculate_costDOU+ cost estimationInspect
DOU+ cost estimation Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie | |
| sec_uid | Yes | 投放账号的 sec_uid/Delivery account sec_uid | |
| item_ids | Yes | 作品ID,多个用逗号分隔/Item id(s), comma separated | |
| target_id | No | 推广目标ID/Promotion target id. 31=点赞评论量, 32=粉丝量, 33=主页浏览量, 37=视频播放量, 45=评论链接点击, 78=高质量互动 |
tikhub_post_api_v1_douyin_douplus_fetch_analyse_detailDelivery analysis detailInspect
Delivery analysis detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 分析查询对象/Analysis query object. 关键字段/key fields: startTime,endTime(秒级时间戳字符串/second timestamp string); analysisType(1=账号/account, 2=视频/video, 3=直播/live); authorSecIdList(账号 sec_uid 列表); statusList(投放状态过滤); metrics(指标列表,如 stat_cost,total_play,total_like,dy_comment,dy_share,dy_follow); SecondaryTargetIds; CollectWayIds. graph 额外/extra: dimension; detail 额外/extra: page,limit,orderByMetric,orderByType; 视频/直播分析额外/extra: liveRoomIdList | |
| cookie | Yes | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie |
tikhub_post_api_v1_douyin_douplus_fetch_analyse_graphDelivery analysis trend graphInspect
Delivery analysis trend graph Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 分析查询对象/Analysis query object. 关键字段/key fields: startTime,endTime(秒级时间戳字符串/second timestamp string); analysisType(1=账号/account, 2=视频/video, 3=直播/live); authorSecIdList(账号 sec_uid 列表); statusList(投放状态过滤); metrics(指标列表,如 stat_cost,total_play,total_like,dy_comment,dy_share,dy_follow); SecondaryTargetIds; CollectWayIds. graph 额外/extra: dimension; detail 额外/extra: page,limit,orderByMetric,orderByType; 视频/直播分析额外/extra: liveRoomIdList | |
| cookie | Yes | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie |
tikhub_post_api_v1_douyin_douplus_fetch_analyse_overview投放数据概览(账号/视频/直播)/Delivery analysis overviewInspect
投放数据概览(账号/视频/直播)/Delivery analysis overview Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 分析查询对象/Analysis query object. 关键字段/key fields: startTime,endTime(秒级时间戳字符串/second timestamp string); analysisType(1=账号/account, 2=视频/video, 3=直播/live); authorSecIdList(账号 sec_uid 列表); statusList(投放状态过滤); metrics(指标列表,如 stat_cost,total_play,total_like,dy_comment,dy_share,dy_follow); SecondaryTargetIds; CollectWayIds. graph 额外/extra: dimension; detail 额外/extra: page,limit,orderByMetric,orderByType; 视频/直播分析额外/extra: liveRoomIdList | |
| cookie | Yes | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie |
tikhub_post_api_v1_douyin_douplus_fetch_promotable_item_listGet promotable item list (with like & comment counts)Inspect
Get promotable item list (with like & comment counts) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 返回作品数量/Number of items | |
| aim_ids | No | 可选高级参数:投放优化目标编码,多个逗号分隔;留空即可(按 target_id 自动匹配),一般无需填写/Optional advanced param: optimization objective code(s), comma separated; leave empty (auto-matched by target_id), usually no need to set | |
| sec_uid | Yes | 投放账号的 sec_uid/Delivery account sec_uid | |
| target_id | No | 推广目标(DOU+ 页面上的目标卡片)ID/Promotion target id (the goal card on the page). 31=点赞评论量, 32=粉丝量, 33=主页浏览量, 37=视频播放量, 40=直播间人气, 45=评论链接点击, 63=展示给粉丝, 78=高质量互动. 仅用于按推广目标筛选可投作品;只拉作品列表用默认 31 即可/Only filters promotable items by goal; keep 31 for a plain video list |
tikhub_post_api_v1_douyin_douplus_fetch_promoted_accountsGet promoted accountsInspect
Get promoted accounts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 每页账号数量/Number of accounts per page | |
| cookie | Yes | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie | |
| cursor | No | 翻页游标,首页留空,后续传上一页响应里的 sortID 值/Pagination cursor, empty for first page, then pass the `sortID` value from the previous response |
tikhub_post_api_v1_douyin_douplus_fetch_sec_tokenGet DOU+ sec_token for POST requestsInspect
Get DOU+ sec_token for POST requests Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie |
tikhub_post_api_v1_douyin_douplus_fetch_talent_categoriesGet talent categoriesInspect
Get talent categories Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie |
tikhub_post_api_v1_douyin_douplus_fetch_talents_by_categorySearch talents by categoryInspect
Search talents by category Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | 达人分类名/搜索词(取自达人分类接口);留空为全部/Category name or keyword (from the talent category endpoint); empty for all | |
| page | No | 页码,从0开始/Page index from 0 | |
| limit | No | 每页数量/Page size | |
| cookie | No | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie |
tikhub_post_api_v1_douyin_douplus_fetch_user_postsGet user homepage postsInspect
Get user homepage posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Page size | |
| cookie | No | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie | |
| cursor | No | 翻页游标(字符串),首页传 "0",后续传上一页响应里的 cursor/Pagination cursor (string), "0" for first page, then pass the cursor from the previous response | |
| sec_uid | Yes | 用户 sec_uid/User sec_uid |
tikhub_post_api_v1_douyin_douplus_fetch_video_detailGet video detail (by id or link)Inspect
Get video detail (by id or link) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| video | Yes | 视频ID 或 视频链接/分享文本/Video ID, or share link/text. 例/e.g. "7651708301280906538" 或/or 含 v.douyin.com 链接的分享文案 | |
| cookie | No | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie |
tikhub_post_api_v1_douyin_douplus_fetch_video_rankingGet DOU+ video rankingInspect
Get DOU+ video ranking Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| adv_id | No | 广告主ID,可留空/Advertiser id (optional) | |
| tag_id | No | 垂类ID/Category id. 601剧情,602明星,606音乐,607二次元,608游戏,609时事,612舞蹈,614三农,615科技,616财经,617亲子,619生活,621健康,623情感,624文化,625职场,626教育,627摄影,628美食,629旅行,631时尚,633体育,634娱乐,635汽车 | |
| dim_type | No | 榜单维度/Ranking dimension: 1=低粉爆款, 2=高完播率, 3=高点赞率, 4=高涨粉率, 5=热度指数 | |
| time_range | No | 时间范围/Time range: 1 / 2 / 3 |
tikhub_post_api_v1_douyin_douplus_search_live_room搜索直播间(抖音号/昵称)/Search live rooms (by Douyin ID or nickname)Inspect
搜索直播间(抖音号/昵称)/Search live rooms (by Douyin ID or nickname) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Page size | |
| cookie | No | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie | |
| cursor | No | 翻页游标,首页传 0,后续传上一页响应里的 cursor/Pagination cursor, 0 for first page | |
| keyword | Yes | 抖音号 或 抖音昵称/Douyin ID or nickname |
tikhub_post_api_v1_douyin_douplus_search_userSearch DOU+ userInspect
Search DOU+ user Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number of results per page | |
| cursor | No | 翻页游标,首页传 0,后续传上一页响应里的 cursor/Pagination cursor, 0 for first page, then pass the cursor from the previous response | |
| keyword | Yes | 搜索关键词,支持抖音号/ID/昵称/Search keyword (Douyin ID / nickname) |
tikhub_post_api_v1_douyin_douplus_search_user_v2Search user V2Inspect
Search user V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Page size | |
| scope | No | 搜索范围/Search scope | |
| cookie | No | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie | |
| cursor | No | 翻页游标,首页传 0,后续传上一页响应里的 cursor/Pagination cursor, 0 for first page | |
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_post_api_v1_douyin_douplus_search_videoSearch videos (by title)Inspect
Search videos (by title) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Page size | |
| cookie | No | 用户 www.douyin.com 网页版 Cookie/User www.douyin.com web Cookie | |
| cursor | No | 翻页游标,首页传 0,后续传上一页响应里的 cursor/Pagination cursor, 0 for first page | |
| keyword | Yes | 视频标题/关键词/Video title or keyword |
tikhub_post_api_v1_douyin_index_fetch_brand_cyclesGet brand cyclesInspect
Get brand cycles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| brand_name | Yes | 品牌名称/Brand name | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_brand_hot_videos_time_scopBrand hot videos time scopeInspect
Brand hot videos time scope Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_post_api_v1_douyin_index_fetch_brand_initiative_rank_weekGet brand initiative rank weeklyInspect
Get brand initiative rank weekly Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| brand_name | Yes | 品牌名称/Brand name | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_brand_linesGet brand trend linesInspect
Get brand trend lines Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| brand_name | Yes | 品牌名称/Brand name | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_brand_radar_chartGet brand radar chartInspect
Get brand radar chart Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| brand_name | Yes | 品牌名称/Brand name | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_brand_suggestBrand search suggestInspect
Brand search suggest Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 品牌名称关键词/Brand keyword |
tikhub_post_api_v1_douyin_index_fetch_brand_valid_infoGet brand indexInspect
Get brand index Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword_list | Yes | 品牌名称列表逗号分隔/Brand list comma separated |
tikhub_post_api_v1_douyin_index_fetch_content_author_portraitContent author portraitInspect
Content author portrait Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | 时间粒度/Period: week or month | |
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部**(同 fetch_item_query 的 category_id 但不接受 0)/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) | |
| end_date | Yes | 结束日期/End date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_content_consumer_portraitContent consumer portraitInspect
Content consumer portrait Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | 时间粒度/Period: week or month | |
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部**(同 fetch_item_query 的 category_id 但不接受 0)/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) | |
| end_date | Yes | 结束日期/End date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_content_consume_trendContent consume trendInspect
Content consume trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部**(同 fetch_item_query 的 category_id 但不接受 0)/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_content_creative_durationContent creative durationInspect
Content creative duration Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | 时间粒度/Period: week=周, month=月 | |
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部**(同 fetch_item_query 的 category_id 但不接受 0)/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) | |
| end_date | Yes | 结束日期/End date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_content_creative_keyword_iCreative keyword related itemsInspect
Creative keyword related items Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | 时间周期/Period: 1, 3, 7 | |
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部** / Category ID, **required, does NOT support 0=all** | |
| keyword | Yes | 关键词(从 fetch_content_creative_keywords 获取)/Keyword (get from fetch_content_creative_keywords) | |
| end_date | Yes | 结束日期 YYYYMMDD(**仅当 period=7 时必须为周日**,period=1/3 时可为任意日期)/End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3) |
tikhub_post_api_v1_douyin_index_fetch_content_creative_keywordsContent creative keywordsInspect
Content creative keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | 时间周期/Period: 1=近1天, 3=近3天, 7=近7天 | |
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部**(同 fetch_item_query 的 category_id 但不接受 0)/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) | |
| end_date | Yes | 结束日期 YYYYMMDD(**仅当 period=7 时必须为周日**,period=1/3 时可为任意日期)/End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3) |
tikhub_post_api_v1_douyin_index_fetch_content_creative_topicContent creative topicInspect
Content creative topic Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | 时间周期/Period: 1, 3, 7 | |
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部** / Category ID, **required, does NOT support 0=all** | |
| end_date | Yes | 结束日期 YYYYMMDD(**仅当 period=7 时必须为周日**,period=1/3 时可为任意日期)/End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3) | |
| rank_type | No | 排序类型/Rank type: index=指数排序, rise=飙升排序 |
tikhub_post_api_v1_douyin_index_fetch_content_interact_trendContent interact trendInspect
Content interact trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tag_id | Yes | 垂类ID,**必填,不支持 0=全部**(同 fetch_item_query 的 category_id 但不接受 0)/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_daren_compare_users_stableDaren compare usersInspect
Daren compare users Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | 天数/Days: 7 or 30 | |
| user_list | Yes | 达人抖音 uid 列表,逗号分隔,最多5个 / Daren uid list, comma separated, max 5 |
tikhub_post_api_v1_douyin_index_fetch_daren_great_item_mile_infoGet daren core metricsInspect
Get daren core metrics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 达人抖音 uid (纯数字) / Douyin uid (numeric). Example: 3100268042915212 |
tikhub_post_api_v1_douyin_index_fetch_daren_great_user_fans_infoGet daren fans analysisInspect
Get daren fans analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 达人抖音 uid (纯数字) / Douyin uid (numeric). Example: 3100268042915212 |
tikhub_post_api_v1_douyin_index_fetch_daren_great_user_top_videoGet daren top videosInspect
Get daren top videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 达人抖音 uid (纯数字) / Douyin uid (numeric). Example: 3100268042915212 | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_daren_similar_usersGet similar darenInspect
Get similar daren Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 达人抖音 uid (纯数字) / Douyin uid (numeric). Example: 3100268042915212 |
tikhub_post_api_v1_douyin_index_fetch_daren_sug_great_user_listDaren search suggestInspect
Daren search suggest Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| total | No | 返回数量/Return count | |
| keyword | Yes | 搜索关键词/Search keyword |
tikhub_post_api_v1_douyin_index_fetch_get_user_sub_wordGet user subscribed keywordsInspect
Get user subscribed keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_post_api_v1_douyin_index_fetch_item_analysisGet video comparison analysisInspect
Get video comparison analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频ID(抖音 aweme id,纯数字)/Video ID (Douyin aweme id, numeric). Example: 7660090930283744575 | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_item_baseGet video detailInspect
Get video detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频ID(抖音 aweme id,纯数字)/Video ID (Douyin aweme id, numeric). Example: 7660090930283744575 |
tikhub_post_api_v1_douyin_index_fetch_item_indexGet video index trendInspect
Get video index trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频ID(抖音 aweme id,纯数字)/Video ID (Douyin aweme id, numeric). Example: 7660090930283744575 | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_item_index_interpretGet video index interpretationInspect
Get video index interpretation Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频ID(抖音 aweme id,纯数字)/Video ID (Douyin aweme id, numeric). Example: 7660090930283744575 | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_item_queryVideo search resultsInspect
Video search results Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword | |
| date_type | No | 发布时间类型(可通过 fetch_item_filter_options 获取)/Date type (get from fetch_item_filter_options), 0=不限/unlimited | |
| label_type | No | 视频类型(可通过 fetch_item_filter_options 获取)/Label type (get from fetch_item_filter_options), 0=不限/unlimited | |
| category_id | No | 垂类ID(可通过 fetch_item_filter_options 获取)/Category ID (get from fetch_item_filter_options), 0=全部/all | |
| duration_type | No | 时长类型(可通过 fetch_item_filter_options 获取)/Duration type (get from fetch_item_filter_options), 0=不限/unlimited |
tikhub_post_api_v1_douyin_index_fetch_item_sugVideo search suggestInspect
Video search suggest Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | 搜索关键词/Search keyword |
tikhub_post_api_v1_douyin_index_fetch_item_user_profileGet video audience profileInspect
Get video audience profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频ID(抖音 aweme id,纯数字)/Video ID (Douyin aweme id, numeric). Example: 7660090930283744575 | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_keyword_valid_dateGet keyword valid dateInspect
Get keyword valid date Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword_list | Yes | 关键词列表,逗号分隔/Keyword list, comma separated |
tikhub_post_api_v1_douyin_index_fetch_multi_keyword_hot_trendGet multi-keyword hot trendInspect
Get multi-keyword hot trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区列表,逗号分隔/Region list, comma separated | |
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date, YYYYMMDD | |
| start_date | Yes | 开始日期/Start date, YYYYMMDD | |
| keyword_list | Yes | 关键词列表,逗号分隔/Keyword list, comma separated |
tikhub_post_api_v1_douyin_index_fetch_multi_keyword_interpretatiGet multi-keyword interpretationInspect
Get multi-keyword interpretation Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 地区列表,逗号分隔/Region list, comma separated | |
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date, YYYYMMDD | |
| start_date | Yes | 开始日期/Start date, YYYYMMDD | |
| keyword_list | Yes | 关键词列表,逗号分隔/Keyword list, comma separated |
tikhub_post_api_v1_douyin_index_fetch_portraitGet crowd portraitInspect
Get crowd portrait Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 关键词/Keyword | |
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_relation_wordGet relation word analysisInspect
Get relation word analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 关键词/Keyword | |
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期(必须为周日)/End date (must be Sunday) YYYYMMDD | |
| start_date | Yes | 开始日期(周一)/Start date (Monday) YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_report_searchSearch trend reportsInspect
Search trend reports Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | 报告类型/Report type: 空=全部, 行业洞察=Industry, 产品洞察=Product, 用户洞察=User, 趋势洞察=Trend | |
| search | No | 报告关键词搜索/Search keyword | |
| business | No | 所属产品列表,逗号分隔/Business list, comma separated. Options: 巨量引擎, 今日头条, 抖音, 西瓜视频, 抖音电商, 仕小禄, 其他 | |
| category | No | 顶层分类ID(默认 6 表示抖音指数趋势报告)/Top category ID (default 6 = Douyin Index trend reports) | |
| page_size | No | 每页数量/Page size | |
| report_time | No | 发布年份列表,逗号分隔/Year list, comma separated. e.g. 2024,2023 | |
| current_page | No | 页码/Page number |
tikhub_post_api_v1_douyin_index_fetch_topic_queryTopic search resultsInspect
Topic search results Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 话题关键词/Topic keyword | |
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) | |
| end_date | Yes | 结束日期/End date YYYYMMDD | |
| start_date | Yes | 开始日期/Start date YYYYMMDD |
tikhub_post_api_v1_douyin_index_fetch_topic_suggestTopic search suggestInspect
Topic search suggest Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | 话题关键词/Topic keyword | |
| app_name | No | 平台/Platform: aweme(抖音), toutiao(头条) |
tikhub_post_api_v1_douyin_search_fetch_challenge_search_v1Fetch hashtag search V1Inspect
Fetch hashtag search V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_challenge_search_v2Fetch hashtag search V2Inspect
Fetch hashtag search V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_challenge_suggestFetch hashtag suggestionsInspect
Fetch hashtag suggestions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 关键词,如 '游戏' / Keyword, e.g., 'game' |
tikhub_post_api_v1_douyin_search_fetch_discuss_searchFetch discussion searchInspect
Fetch discussion search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_experience_searchFetch experience searchInspect
Fetch experience search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_general_search_v1Fetch general search V1Inspect
Fetch general search V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_general_search_v2Fetch general search V2Inspect
Fetch general search V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_general_search_v3Fetch general search V3Inspect
Fetch general search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,取值 1~200,首次请求传 1,之后每次加 1 / Page number, 1-200, start with 1 and increment by 1 each time | |
| offset | No | 翻页游标,从上一次响应的 data.pagination.offset 获取,首次请求传 0 / Offset cursor for pagination, obtained from data.pagination.offset of the last response, 0 for the first request | |
| keyword | No | 搜索关键词 / Search keyword | |
| backtrace | No | 翻页回溯标识,从上一次响应的 data.pagination.backtrace 获取,首次请求传空字符串 / Backtrace, obtained from data.pagination.backtrace of the last response, empty for the first request | |
| search_id | No | 搜索ID,从上一次响应的 data.pagination.search_id 获取,首次请求传空字符串 / Search ID, obtained from data.pagination.search_id of the last response, empty for the first request |
tikhub_post_api_v1_douyin_search_fetch_image_searchFetch image searchInspect
Fetch image search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_image_search_v3Fetch image-text search V3Inspect
Fetch image-text search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标/Pagination cursor | |
| keyword | Yes | 搜索关键词/Search keyword | |
| search_id | No | 搜索ID/Search ID for pagination |
tikhub_post_api_v1_douyin_search_fetch_live_search_v2Fetch live search V2Inspect
Fetch live search V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标,首次请求传 0,之后传上一页响应里的 cursor / Pagination cursor, 0 for the first request, then the cursor from the last response | |
| keyword | No | 抖音号 或 抖音昵称 / Douyin ID or nickname |
tikhub_post_api_v1_douyin_search_fetch_multi_searchFetch multi-type searchInspect
Fetch multi-type search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_music_searchFetch music searchInspect
Fetch music search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_school_searchFetch school searchInspect
Fetch school search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 关键词,如学校名称或所在地区 / Keyword, such as school name or location |
tikhub_post_api_v1_douyin_search_fetch_search_suggestFetch search keyword suggestionsInspect
Fetch search keyword suggestions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 需要联想的关键词/The keyword to be suggested |
tikhub_post_api_v1_douyin_search_fetch_search_suggest_v2Fetch search keyword suggestions V2Inspect
Fetch search keyword suggestions V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | 需要联想的关键词/The keyword to be suggested | |
| history_words | No | 可选,用户的历史搜索词(英文逗号分隔),会影响联想词的排序/Optional, the user's history search words (comma separated), affects the ranking of suggestions |
tikhub_post_api_v1_douyin_search_fetch_user_searchFetch user searchInspect
Fetch user search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| douyin_user_fans | No | 粉丝数过滤:空=不限 0_1k=1千以下 1k_5k=1千到5千 5k_10k=5千到1万 10k_100k=1万到10万 100k_1M=10万到100万 1M_=100万以上 / Fans filter: empty=No limit, 0_1k=Under 1k, etc. | |
| douyin_user_type | No | 用户类型过滤:空=不限 300=创作者 900=小店 700=音乐人 800=明星 / User type filter: empty=No limit, 300=Creator, 900=Shop, 700=Musician, 800=Celebrity |
tikhub_post_api_v1_douyin_search_fetch_user_search_v2Fetch user search V2Inspect
Fetch user search V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword |
tikhub_post_api_v1_douyin_search_fetch_video_search_v1Fetch video search V1Inspect
Fetch video search V1 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_video_search_v2Fetch video search V2Inspect
Fetch video search V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response | |
| keyword | No | 关键词 / Keyword | |
| backtrace | No | 翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response | |
| search_id | No | 搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response | |
| sort_type | No | 排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest | |
| content_type | No | 内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article | |
| publish_time | No | 发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year | |
| filter_duration | No | 视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes |
tikhub_post_api_v1_douyin_search_fetch_video_search_v3Fetch video search V3Inspect
Fetch video search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | 搜索关键词/Search keyword | |
| date_type | No | 发布时间筛选:0=不限, 3=近3天, 7=近7天, 30=近一个月/Publish date filter: 0=any, 3=last 3 days, 7=last 7 days, 30=last 30 days | |
| label_type | No | 视频类型筛选:0=不限, 1=低粉爆款, 2=高完播率, 3=高涨粉率, 4=高点赞率/Video type filter: 0=any, 1=low-follower hit, 2=high completion rate, 3=high follower growth, 4=high like rate | |
| duration_type | No | 时长筛选:0=不限, 1=0-15秒, 6=15-60秒, 7=60-120秒, 8=120-180秒, 9=大于180秒/Duration filter: 0=any, 1=0-15s, 6=15-60s, 7=60-120s, 8=120-180s, 9=over 180s |
tikhub_post_api_v1_douyin_search_fetch_video_search_v4Fetch video search V4Inspect
Fetch video search V4 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | 翻页游标,首次请求传 0,之后传上一页响应里的 cursor / Pagination cursor, 0 for the first request, then the cursor from the last response | |
| keyword | No | 视频标题/关键词 / Video title or keyword |
tikhub_post_api_v1_douyin_search_fetch_video_search_v5Fetch video search V5Inspect
Fetch video search V5 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码,取值 1~200,首次请求传 1,之后每次加 1 / Page number, 1-200, start with 1 and increment by 1 each time | |
| offset | No | 翻页游标,从上一次响应的 data.pagination.offset 获取,首次请求传 0 / Offset cursor for pagination, obtained from data.pagination.offset of the last response, 0 for the first request | |
| keyword | No | 搜索关键词 / Search keyword | |
| backtrace | No | 翻页回溯标识,从上一次响应的 data.pagination.backtrace 获取,首次请求传空字符串 / Backtrace, obtained from data.pagination.backtrace of the last response, empty for the first request | |
| search_id | No | 搜索ID,从上一次响应的 data.pagination.search_id 获取,首次请求传空字符串 / Search ID, obtained from data.pagination.search_id of the last response, empty for the first request |
tikhub_post_api_v1_douyin_web_fetch_challenge_postsChallenge PostsInspect
Challenge Posts Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Count | |
| cookie | No | 用户自行提供的Cookie/User provided Cookie | |
| cursor | No | 游标/Cursor | |
| sort_type | No | 排序类型/Sort type | |
| challenge_id | No | 话题ID/Challenge ID |
tikhub_post_api_v1_douyin_web_fetch_home_feedGet home feed dataInspect
Get home feed data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 数量/Number | |
| cookie | No | 可选/Optional:用户网页版抖音登录Cookie,传入后返回该账号的个性化推荐;不传则使用默认Cookie/Your web Douyin login Cookie for a personalized feed; uses the default Cookie if omitted | |
| refresh_index | No | 刷新/翻页索引:0=刷新(首页/下拉),>0=翻页(下滑加载更多),每次+1取下一页 / Refresh-paging index: 0=refresh, >0=load-more, increment by 1 for next page |
tikhub_post_api_v1_douyin_web_fetch_multi_videoBatch Get Video InformationInspect
Batch Get Video Information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
tikhub_post_api_v1_douyin_web_fetch_multi_video_high_quality_plaBatch get the highest quality play URL of videosInspect
Batch get the highest quality play URL of videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | 可选,请求出口地区(ISO 国家代码,如 CN/US/HK)。抖音根据请求 IP 返回对应区域 CDN,国内用户传 'CN' 可获得国内 CDN 链接以加快下载速度 / Optional, ISO country code (e.g. CN). Pass 'CN' for users in mainland China to get China-region CDN URLs for faster download. | |
| aweme_ids | No | 作品id列表,用逗号分隔,最多50个/Video id list, separated by commas, up to 50 |
tikhub_post_api_v1_douyin_web_fetch_query_userQuery Douyin user basic informationInspect
Query Douyin user basic information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 用户ttwid Cookie,获取方式:调用`/api/v1/douyin/web/generate_ttwid`接口获取。/User ttwid Cookie, acquisition method: call `/api/v1/douyin/web/generate_ttwid` interface to get. |
tikhub_post_api_v1_douyin_web_fetch_user_collection_videosGet user collection video dataInspect
Get user collection video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户网页版抖音Cookie/Your web version of Douyin Cookie | |
| counts | No | 每页数量/Number per page | |
| max_cursor | No | 最大游标/Maximum cursor |
tikhub_post_api_v1_douyin_web_fetch_user_collectsGet user collectionInspect
Get user collection Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | Yes | 用户网页版抖音Cookie/Your web version of Douyin Cookie | |
| counts | No | 每页数量/Number per page | |
| max_cursor | No | 最大游标/Maximum cursor |
tikhub_post_api_v1_douyin_web_fetch_user_like_videosGet user like video dataInspect
Get user like video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户网页版抖音Cookie/Your web version of Douyin Cookie | |
| counts | No | 每页数量/Number per page | |
| max_cursor | No | 最大游标/Maximum cursor | |
| sec_user_id | Yes | 用户sec_user_id/User sec_user_id |
tikhub_post_api_v1_douyin_web_get_all_aweme_idExtract list video idInspect
Extract list video id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 作品链接列表/Video link list |
tikhub_post_api_v1_douyin_web_get_all_sec_user_idExtract list user idInspect
Extract list user id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 用户主页链接列表/User homepage link list |
tikhub_post_api_v1_douyin_web_get_all_webcast_idExtract list webcast idInspect
Extract list webcast id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 直播间链接列表/Room link list |
tikhub_post_api_v1_douyin_xingtu_v2_get_ip_activity_listGet IP Activity ListInspect
Get IP Activity List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| status_list | No | IP状态列表/IP status list | |
| category_list | No | IP类型列表/IP category list | |
| query_end_time | Yes | 查询结束时间戳/Query end timestamp | |
| industry_id_list | No | 行业ID列表/Industry ID list | |
| query_start_time | Yes | 查询开始时间戳/Query start timestamp |
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_commentsGet Item Report CommentsInspect
Get Item Report Comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频(item) ID/Video (item) ID |
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_detailGet Item Report DetailInspect
Get Item Report Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频(item) ID/Video (item) ID |
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_th_analysisGet Item Report Interaction AnalysisInspect
Get Item Report Interaction Analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频(item) ID/Video (item) ID |
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_trendGet Item Report TrendInspect
Get Item Report Trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | 视频(item) ID/Video (item) ID |
tikhub_post_api_v1_douyin_xingtu_v2_get_playlet_actor_rank_catalGet Playlet Actor Rank CatalogInspect
Get Playlet Actor Rank Catalog Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_post_api_v1_douyin_xingtu_v2_get_recommend_for_star_authoGet Recommend Similar Star AuthorsInspect
Get Recommend Similar Star Authors Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| author_ids | Yes | 创作者ID列表/List of creator author IDs | |
| similar_type | No | 相似类型/Similarity type |
tikhub_post_api_v1_douyin_xingtu_v2_multi_get_author_infoMulti Get Author InfoInspect
Multi Get Author Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| author_ids | Yes | 创作者ID列表,一次最多50个/Creator ID list, up to 50 per call | |
| platform_source | No | 平台来源/Platform source | |
| platform_channel | No | 平台渠道/Platform channel |
tikhub_post_api_v1_douyin_xingtu_v2_multi_get_item_stats批量获取视频数据(播放量/点赞等)/Multi Get Item StatsInspect
批量获取视频数据(播放量/点赞等)/Multi Get Item Stats Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| item_ids | Yes | 视频(item) ID列表,一次最多20个/Video (item) ID list, up to 20 per call | |
| need_cover_url | No | 是否返回封面URL/Whether to return cover URL | |
| platform_source | No | 平台来源/Platform source |
tikhub_post_api_v1_lemon8_app_get_item_idsGet post IDs in batch through sharing linksInspect
Get post IDs in batch through sharing links Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 分享链接列表/Share links list |
tikhub_post_api_v1_lemon8_app_get_user_idsGet user IDs in batch through sharing linksInspect
Get user IDs in batch through sharing links Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 分享链接列表/Share links list |
tikhub_post_api_v1_tiktok_ads_get_ad_interactive_analysisGet ad interactive analysisInspect
Get ad interactive analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 自定义Cookie字符串(可选) | |
| material_id | Yes | 广告素材ID/Ad material ID | |
| metric_type | No | 分析类型/Analysis type (ctr, cvr, clicks, conversion, remain) | |
| period_type | No | 时间范围(天)/Period type (days) |
tikhub_post_api_v1_tiktok_ads_get_ad_keyframe_analysisGet ad keyframe analysisInspect
Get ad keyframe analysis Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 自定义Cookie字符串(可选) | |
| metric | No | 分析指标/Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt) | |
| material_id | Yes | 广告素材ID/Ad material ID |
tikhub_post_api_v1_tiktok_ads_get_ad_percentileGet ad percentile dataInspect
Get ad percentile data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 自定义Cookie字符串(可选) | |
| metric | No | 分析指标/Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt_percentile, show_cnt_percentile) | |
| material_id | Yes | 广告素材ID/Ad material ID | |
| period_type | No | 时间范围(天)/Time period (days) |
tikhub_post_api_v1_tiktok_ads_get_ads_detailGet single ad detailInspect
Get single ad detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ads_id | Yes | 广告ID/Ad ID | |
| cookie | No | 自定义Cookie字符串(可选) |
tikhub_post_api_v1_tiktok_ads_get_configure_safetyGet search modules configInspect
Get search modules config Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) |
tikhub_post_api_v1_tiktok_ads_get_creators_cardGet creators cardInspect
Get creators card Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) | |
| tt_uids | No | 创作者ID列表/Creator ID list | |
| creator_type | No | 创作者类型/Creator type | |
| need_loader_list | No | 需要返回的数据模块编号,空为全部/Data module IDs, empty for all |
tikhub_post_api_v1_tiktok_ads_get_location_listGet supported location listInspect
Get supported location list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) |
tikhub_post_api_v1_tiktok_ads_get_query_suggestionsGet query suggestionsInspect
Get query suggestions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 建议数量/Suggestion count | |
| query | No | 场景1留空返回热门建议;场景2传入关键词/Empty for scenario 1; input a keyword for scenario 2 | |
| cookie | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) | |
| scenario | No | 场景类型:1热门建议,2关键词联想/1 popular, 2 related suggestions | |
| country_code | No | 可选国家/地区代码/Optional country code |
tikhub_post_api_v1_tiktok_ads_get_recommended_adsGet recommended adsInspect
Get recommended ads Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 自定义Cookie字符串(可选) | |
| industry | No | 行业ID/Industry ID | |
| material_id | Yes | 广告素材ID/Ad material ID | |
| country_code | No | 国家代码/Country code |
tikhub_post_api_v1_tiktok_ads_get_top_ads_filtersGet Top Ads filtersInspect
Get Top Ads filters Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 自定义Cookie字符串(可选) |
tikhub_post_api_v1_tiktok_ads_get_top_ads_spotlightGet top ads spotlightInspect
Get top ads spotlight Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| limit | No | 每页数量/Items per page | |
| cookie | No | 自定义Cookie字符串(可选) | |
| industry | No | 行业ID(可选,不传返回跨行业聚合)/Industry ID (optional) |
tikhub_post_api_v1_tiktok_ads_get_top_contents_item_detailGet top contents item detailInspect
Get top contents item detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) | |
| item_id | Yes | 视频ID/Video item ID | |
| country_code | No | 该视频所属榜单的国家/地区代码,需与榜单查询一致/Country code of the ranking | |
| period_dimension | No | 榜单周期:1/3/5 /Period dimension | |
| period_end_timestamp | Yes | 调用方需根据目标榜单日期自行生成结束时间戳(10位 Unix 秒级),例如 1785024000;请勿传 0,否则会返回空结果/The caller must generate this 10-digit Unix timestamp in seconds from the target ranking date, for example 1785024000; do not pass 0 because it returns an empty result |
tikhub_post_api_v1_tiktok_ads_get_top_contents_listGet top contents listInspect
Get top contents list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| limit | No | 每页数量,最大100/Items per page, max 100 | |
| cookie | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) | |
| country_code | No | 国家/地区代码/Country code | |
| organic_only | No | 是否仅看自然流量内容/Organic content only | |
| order_by_metric | No | 排序指标:1 播放量 2 互动率 3 6秒完播率/Order by metric | |
| period_dimension | No | 榜单周期:1/3/5 /Period dimension | |
| content_label_ids | No | 内容分类ID,多个用逗号分隔,空为全部/Content label IDs, comma separated | |
| period_end_timestamp | Yes | 调用方需根据目标榜单日期自行生成结束时间戳(10位 Unix 秒级),例如 1785024000;请勿传 0,否则会返回空结果/The caller must generate this 10-digit Unix timestamp in seconds from the target ranking date, for example 1785024000; do not pass 0 because it returns an empty result |
tikhub_post_api_v1_tiktok_ads_get_trends_hashtag_detailGet trending hashtag detailInspect
Get trending hashtag detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) | |
| hashtag_id | Yes | 标签ID/Hashtag ID | |
| time_range | No | 时间范围(天):7/30/90 /Time range in days | |
| country_code | No | 国家/地区代码/Country code |
tikhub_post_api_v1_tiktok_ads_get_trends_hashtag_listGet trending hashtag listInspect
Get trending hashtag list Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page number | |
| limit | No | 每页数量/Items per page | |
| cookie | No | 自定义Cookie字符串(可选)/Custom Cookie string (optional) | |
| time_range | No | 时间范围(天):7/30/90 /Time range in days | |
| industry_id | No | 一级行业ID(可选),如10000000000=Education/First-level industry ID (optional) | |
| country_code | No | 国家/地区代码/Country code |
tikhub_post_api_v1_tiktok_ads_search_adsSearch adsInspect
Search ads Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| like | No | 表现排名(可选)/Performance rank (optional; 1:前1-20% 2:前21-40% 3:前41-60% 4:前61-80% 5:前81-100%) | |
| page | No | 页码/Page number | |
| limit | No | 每页数量/Items per page | |
| cookie | No | 自定义Cookie字符串(可选) | |
| period | No | 时间段/Time period (days) | |
| keyword | No | 搜索关键词/Search keyword | |
| duration | No | 视频时长筛选值(可选)/Video duration filter value (optional) | |
| industry | No | 行业ID/Industry ID | |
| order_by | No | 排序方式/Sort by (for_you, likes) | |
| ad_format | No | 广告格式(可选)/Ad format (optional; 1:Spark Ads 2:Non-Spark Ads) | |
| objective | No | 广告目标类型(可选)/Ad objective (optional; 1:流量 2:应用安装 3:转化 4:视频浏览 5:触达 6:潜在客户 7:产品销售) | |
| search_id | No | 搜索ID(可选)/Search ID (optional) | |
| ad_language | No | 广告语言(可选)/Ad language (optional) | |
| country_code | No | 国家代码/Country code | |
| pattern_label | No | 创意趋势标签(可选)/Creative pattern label (optional) |
tikhub_post_api_v1_tiktok_app_v3_check_live_room_online_batchBatch check if live rooms are onlineInspect
Batch check if live rooms are online Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| room_ids | No | 多个直播间ID组成的数组 / List of TikTok live room IDs |
tikhub_post_api_v1_tiktok_app_v3_encrypt_decrypt_login_requestEncrypt or Decrypt TikTok APP login request bodyInspect
Encrypt or Decrypt TikTok APP login request body Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Encrypt or decrypt the input string | |
| password | No | Plaintext or encrypted password | |
| username | No | Plaintext or encrypted username |
tikhub_post_api_v1_tiktok_app_v3_fetch_content_translateGet content translation dataInspect
Get content translation data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| trg_lang | No | 目标语言ISO639-1代码,例如:zh-Hans/ Target language ISO639-1 code, e.g. zh-Hans | |
| src_content | No | 源语言内容,也就是需要翻译的内容/ Source language content, i.e. the content to be translated |
tikhub_post_api_v1_tiktok_app_v3_fetch_home_feedGet home feed(recommend) video dataInspect
Get home feed(recommend) video data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cookie | No | 用户自己的cookie,可选参数,用于接口返回数据的个性化推荐。/ User's own cookie, optional parameter, used for personalized recommendations of interface return data. |
tikhub_post_api_v1_tiktok_app_v3_fetch_multi_videoBatch Get Video InformationInspect
Batch Get Video Information Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 作品id列表/Video id list |
tikhub_post_api_v1_tiktok_app_v3_fetch_multi_video_v2Batch Get Video Information V2Inspect
Batch Get Video Information V2 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 作品id列表/Video id list |
tikhub_post_api_v1_tiktok_app_v3_ttencrypt_algorithmTikTok APP encryption algorithmInspect
TikTok APP encryption algorithm Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | 需要加密的URL/URL to be encrypted | |
| data | No | 如果有POST请求,请填写POST请求的数据参与加密计算/If there is a POST request, please fill in the data of the POST request to participate in the encryption calculation | |
| device_info | No | 设备信息,可选参数,如果不填写则使用默认设备信息/Device information, optional parameter, if not filled in, the default device information is used |
tikhub_post_api_v1_tiktok_creator_get_account_health_statusGet Creator Account Health StatusInspect
Get Creator Account Health Status Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String |
tikhub_post_api_v1_tiktok_creator_get_account_insights_overviewGet Creator Account OverviewInspect
Get Creator Account Overview Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| start_date | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' |
tikhub_post_api_v1_tiktok_creator_get_account_violation_listGet Creator Account Violation Record ListInspect
Get Creator Account Violation Record List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page Number | |
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String |
tikhub_post_api_v1_tiktok_creator_get_creator_account_infoGet Creator Account InfoInspect
Get Creator Account Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String |
tikhub_post_api_v1_tiktok_creator_get_live_analytics_summaryGet Creator Live OverviewInspect
Get Creator Live Overview Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| start_date | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' |
tikhub_post_api_v1_tiktok_creator_get_product_analytics_listGet Creator Product List AnalyticsInspect
Get Creator Product List Analytics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page Number | |
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| end_date | No | 结束日期,如 '2025-05-01'/ End Date, e.g. '2025-05-01' | |
| start_date | No | 开始日期,如 '2025-04-01'/ Start Date, e.g. '2025-04-01' |
tikhub_post_api_v1_tiktok_creator_get_showcase_product_listGet Showcase Product ListInspect
Get Showcase Product List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Page Size | |
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| offset | No | 偏移量/Offset |
tikhub_post_api_v1_tiktok_creator_get_video_analytics_summaryGet Creator Video OverviewInspect
Get Creator Video Overview Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String |
tikhub_post_api_v1_tiktok_creator_get_video_associated_product_lGet Video Associated Product ListInspect
Get Video Associated Product List Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| item_ids | Yes | 视频 ID 列表/Video ID List | |
| start_date | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' |
tikhub_post_api_v1_tiktok_creator_get_video_audience_statsGet Video Audience Analysis DataInspect
Get Video Audience Analysis Data Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| item_id | Yes | 视频 ID/Video ID | |
| start_date | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' |
tikhub_post_api_v1_tiktok_creator_get_video_detailed_statsGet Video Detailed StatisticsInspect
Get Video Detailed Statistics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| item_id | Yes | 视频 ID/Video ID | |
| start_date | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' |
tikhub_post_api_v1_tiktok_creator_get_video_list_analyticsGet Creator Video List AnalyticsInspect
Get Creator Video List Analytics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 页码/Page Number | |
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| rules | No | 列表排序规则,默认按发布时间排序/ List sorting rule, default is by publish time | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| start_date | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' |
tikhub_post_api_v1_tiktok_creator_get_video_to_product_statsGet Video-Product Association StatisticsInspect
Get Video-Product Association Statistics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| proxy | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | |
| cookie | No | 用户 Cookie 字符串/User Cookie String | |
| item_id | Yes | 视频 ID/Video ID | |
| product_id | Yes | 商品 ID/Product ID | |
| start_date | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' |
tikhub_post_api_v1_tiktok_web_fetch_gift_name_by_idGet gift name by gift IDInspect
Get gift name by gift ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gift_id | Yes | 礼物ID | Gift ID |
tikhub_post_api_v1_tiktok_web_fetch_gift_names_by_ids批量查询Gift ID对应的礼物名称/Batch get gift names by gift IDsInspect
批量查询Gift ID对应的礼物名称/Batch get gift names by gift IDs Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| gift_ids | Yes | 礼物ID列表,建议50个/次获得最佳性价比($0.025),超过50个时自动处理前50个 | Gift ID list, recommend 50/call for best value ($0.025), auto-process first 50 if more than 50 |
tikhub_post_api_v1_tiktok_web_fetch_home_feedHome FeedInspect
Home Feed Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | 每页数量/Number per page | |
| cookie | No | 用户自己的cookie,可选参数,用于接口返回数据的个性化推荐。/ User's own cookie, optional parameter, used for personalized recommendations of interface return data. | |
| region | No | 地区代码,可选参数,影响推荐内容所属地区,如 US/GB/JP/KR/SG 等,默认 US。/ Region code, optional, affects the region of recommended content, e.g. US/GB/JP/KR/SG, default US. |
tikhub_post_api_v1_tiktok_web_generate_xbogusGenerate XBogusInspect
Generate XBogus Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 请求的API URL,不需要进行编码 | The requested API URL, no need to encode | |
| user_agent | Yes | 请求API时的User-Agent | User-Agent when requesting the API |
tikhub_post_api_v1_tiktok_web_generate_xgnarlyGenerate XGnarlyInspect
Generate XGnarly Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 包含域名和参数的请求的API URL,不需要进行URL编码 | The requested API URL, no need to URL encode | |
| body | No | 请求的API参数,适用于POST请求 | The API parameters of the request, applicable for POST requests |
tikhub_post_api_v1_tiktok_web_generate_xgnarly_and_xbogusGenerate XGnarly and XBogusInspect
Generate XGnarly and XBogus Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | 包含域名和参数的请求的API URL,不需要进行URL编码 | The requested API URL, no need to URL encode | |
| body | No | 请求的API参数,适用于POST请求 | The API parameters of the request, applicable for POST requests |
tikhub_post_api_v1_tiktok_web_generate_x_mssdk_infoGenerate X-Mssdk-InfoInspect
Generate X-Mssdk-Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_agent | No | 可选的用户代理字符串,目前不支持自定义,默认为固定的值 | Optional User-Agent string, currently not supported for customization, defaults to a fixed value |
tikhub_post_api_v1_tiktok_web_get_all_aweme_idExtract list video idInspect
Extract list video id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 作品链接/Video link |
tikhub_post_api_v1_tiktok_web_get_all_sec_user_idExtract list user sec_user_idInspect
Extract list user sec_user_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 用户主页链接/User homepage link |
tikhub_post_api_v1_tiktok_web_get_all_unique_idGet list unique_idInspect
Get list unique_id Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 用户主页链接/User homepage link |
tikhub_post_api_v1_wechat_channels_v2_fetch_channel_id_to_usernaConvert Channel ID to Finder UsernameInspect
Convert Channel ID to Finder Username Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| channel_id | Yes | 视频号 ID(sph 开头的短号)/WeChat Channels ID (short ID starting with sph) |
tikhub_post_api_v1_wechat_channels_v2_fetch_channel_infoGet WeChat Channels Account InfoInspect
Get WeChat Channels Account Info Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| username | Yes | 视频号 finder username(v2_…@finder 格式)/WeChat Channels finder username (v2_…@finder format) |
tikhub_post_api_v1_wechat_channels_v2_fetch_collection_videosGet WeChat Channels Collection VideosInspect
Get WeChat Channels Collection Videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构(推荐做媒体下载)/True=raw response; False=simplified parsed structure (recommended for media download) | |
| topic | No | 合集名(可选,提高命中)/Collection name (optional, improves hit rate) | |
| topic_id | Yes | 合集 ID(纯数字,来自 fetch_user_collections 的 topic_id)/Collection ID (numeric, from topic_id of fetch_user_collections) | |
| username | No | 创作者 finder username(可选,提高命中)/Creator finder username (optional, improves hit rate) | |
| topic_type | No | 合集类型,默认 16(与 fetch_user_collections 返回的 topic_type 对齐)/Collection type, default 16 (align with topic_type from fetch_user_collections) | |
| last_buffer | No | 翻页游标(base64),首页留空/Pagination cursor (base64), leave empty for first page |
tikhub_post_api_v1_wechat_channels_v2_fetch_live_detailGet WeChat Channels Live DetailInspect
Get WeChat Channels Live Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| scene | No | 进入场景,默认 5/Entry scene, default 5 | |
| live_id | Yes | 直播 ID(纯数字)/Live ID (numeric) | |
| finder_username | No | 主播 finder username(可选,提高命中)/Anchor finder username (optional, improves hit rate) |
tikhub_post_api_v1_wechat_channels_v2_fetch_live_historyGet WeChat Channels Live HistoryInspect
Get WeChat Channels Live History Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构(推荐做媒体下载)/True=raw response; False=simplified parsed structure (recommended for media download) | |
| flag | No | 拉取标志,默认 12/Fetch flag, default 12 | |
| username | Yes | 视频号 finder username(v2_…@finder 格式)/WeChat Channels finder username (v2_…@finder format) | |
| last_buffer | No | 翻页游标(base64),首页留空/Pagination cursor (base64), leave empty for first page |
tikhub_post_api_v1_wechat_channels_v2_fetch_search_channel_videoSearch Videos Within a WeChat ChannelInspect
Search Videos Within a WeChat Channel Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| cursor | No | 翻页游标:首页留空;翻页时原样回传上一页响应的 next_cursor(不透明字符串,勿解析或拼接)/Pagination cursor: leave empty for the first page; pass back the previous response's next_cursor verbatim (opaque string, do not parse or concatenate) | |
| keyword | Yes | 在该号内搜索的关键词(1-100 字)/Keyword to search within this channel (1-100 chars) | |
| username | Yes | 创作者 finder username(v2_…@finder 格式)/Creator finder username (v2_…@finder format) |
tikhub_post_api_v1_wechat_channels_v2_fetch_user_collectionsGet WeChat Channels User CollectionsInspect
Get WeChat Channels User Collections Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| username | Yes | 视频号 finder username(v2_…@finder 格式)/WeChat Channels finder username (v2_…@finder format) |
tikhub_post_api_v1_wechat_channels_v2_fetch_user_profileGet WeChat Channels User Profile & StatsInspect
Get WeChat Channels User Profile & Stats Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| username | Yes | 视频号 finder username(v2_…@finder 格式)/WeChat Channels finder username (v2_…@finder format) |
tikhub_post_api_v1_wechat_channels_v2_fetch_user_videosGet WeChat Channels User VideosInspect
Get WeChat Channels User Videos Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构(推荐做媒体下载)/True=raw response; False=simplified parsed structure (recommended for media download) | |
| username | Yes | 视频号 finder username(v2_…@finder 格式)/WeChat Channels finder username (v2_…@finder format) | |
| last_buffer | No | 翻页游标(base64),首页留空/Pagination cursor (base64), leave empty for first page |
tikhub_post_api_v1_wechat_channels_v2_fetch_video_commentsGet WeChat Channels Video CommentsInspect
Get WeChat Channels Video Comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| object_id | Yes | 作品 objectId(纯数字)/Video objectId (numeric) | |
| comment_id | No | 展开某条评论的二级回复时传其 commentId(纯数字),首页留空/Pass a commentId (numeric) to expand its replies, leave empty for first-level comments | |
| last_buffer | No | 翻页游标(base64),首页留空/Pagination cursor (base64), leave empty for first page |
tikhub_post_api_v1_wechat_channels_v2_fetch_video_detailGet WeChat Channels Video DetailInspect
Get WeChat Channels Video Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构(推荐做媒体下载)/True=raw response; False=simplified parsed structure (recommended for media download) | |
| export_id | No | 搜索结果中的 exportId(export/ 开头,会过期,需尽快使用)/exportId from search results (starts with export/, expires soon) | |
| object_id | No | 作品 objectId(纯数字,最优先)/Video objectId (numeric, highest priority) | |
| share_url | No | 视频号分享短链(https://weixin.qq.com/sph/…),仅在 object_id 与 export_id 都为空时使用/Share URL (https://weixin.qq.com/sph/…), used only when object_id and export_id are empty | |
| object_nonce_id | No | 配套 objectNonceId(纯数字,可选,提升命中率)/Optional objectNonceId (numeric, improves hit rate) |
tikhub_post_api_v1_wechat_mp_v2_fetch_account_articlesGet WeChat MP Account ArticlesInspect
Get WeChat MP Account Articles Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| offset | No | 翻页游标(base64),首页留空;翻页传上一页响应的 next_offset/Pagination cursor (base64), leave empty for first page; for the next page pass next_offset from the previous response | |
| username | Yes | 公众号 username。三种形态都支持:`gh_…`、`gh_…@app`(关联小程序的账号)、以及自定义微信号(如 `nikejdi`)。取自文章详情接口响应的 `$.data.content.user_name`/Official account username. Three forms are supported: `gh_…`, `gh_…@app` (mini-program-linked accounts) and custom WeChat IDs (e.g. `nikejdi`). Taken from `$.data.content.user_name` of the article detail endpoints | |
| page_size | No | 每页数量(默认 20)。⚠️ 微信当前**忽略**该参数:返回条数由公众号自身决定,实测取 1 与取 40 结果完全相同;翻页请用 offset / next_offset/Articles per page (default 20). NOTE: WeChat currently ignores this parameter — the count is decided by the account itself; paginate with offset / next_offset | |
| item_show_type | No | 内容栏目:留空/0=文章(默认)、5=视频、7=音频、8=贴图/Content tab: empty/0=articles (default), 5=videos, 7=audios, 8=image-text posts |
tikhub_post_api_v1_wechat_mp_v2_fetch_account_profileGet WeChat MP Account ProfileInspect
Get WeChat MP Account Profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| username | Yes | 公众号 username。三种形态都支持:`gh_…`、`gh_…@app`(关联小程序的账号)、以及自定义微信号(如 `nikejdi`)。取自文章详情接口响应的 `$.data.content.user_name`/Official account username. Three forms are supported: `gh_…`, `gh_…@app` (mini-program-linked accounts) and custom WeChat IDs (e.g. `nikejdi`). Taken from `$.data.content.user_name` of the article detail endpoints |
tikhub_post_api_v1_wechat_mp_v2_fetch_account_services获取公众号服务/自定义菜单/Get WeChat MP Account Services & Custom MenuInspect
获取公众号服务/自定义菜单/Get WeChat MP Account Services & Custom Menu Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| username | Yes | 公众号 username。三种形态都支持:`gh_…`、`gh_…@app`(关联小程序的账号)、以及自定义微信号(如 `nikejdi`)。取自文章详情接口响应的 `$.data.content.user_name`/Official account username. Three forms are supported: `gh_…`, `gh_…@app` (mini-program-linked accounts) and custom WeChat IDs (e.g. `nikejdi`). Taken from `$.data.content.user_name` of the article detail endpoints |
tikhub_post_api_v1_wechat_mp_v2_fetch_article_adGet WeChat MP Article AdsInspect
Get WeChat MP Article Ads Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| url | Yes | 公众号文章链接(https://mp.weixin.qq.com/s/… 或带 __biz 的长链)/WeChat MP article URL (https://mp.weixin.qq.com/s/… or long URL with __biz) |
tikhub_post_api_v1_wechat_mp_v2_fetch_article_commentsGet WeChat MP Article CommentsInspect
Get WeChat MP Article Comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| url | Yes | 公众号文章链接(https://mp.weixin.qq.com/s/…)/WeChat MP article URL (https://mp.weixin.qq.com/s/…) | |
| buffer | No | 翻页游标,首页留空;翻页传上一页响应的 buffer/Pagination cursor, leave empty for first page; pass buffer from the previous response | |
| comment_id | No | 文章的评论 id(可选,**性能捷径**):不传时上游要先抓并解析整篇文章 HTML 才能拿到它,约占本接口耗时的一半;已有该值时传进来可显著加快。取自 /fetch_article_detail 或 /fetch_article_detail_h5 响应的 `$.data.content.comment_id`/Article comment id (optional, performance shortcut): when omitted, upstream must fetch and parse the whole article HTML to obtain it, which accounts for about half of this endpoint's latency |
tikhub_post_api_v1_wechat_mp_v2_fetch_article_detailGet WeChat MP Article DetailInspect
Get WeChat MP Article Detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| url | Yes | 公众号文章链接(https://mp.weixin.qq.com/s/… 或带 __biz 的长链)/WeChat MP article URL (https://mp.weixin.qq.com/s/… or long URL with __biz) |
tikhub_post_api_v1_wechat_mp_v2_fetch_article_detail_h5Get WeChat MP Article Detail (H5, Recommended)Inspect
Get WeChat MP Article Detail (H5, Recommended) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| url | Yes | 公众号文章链接(https://mp.weixin.qq.com/s/… 或带 __biz 的长链)/WeChat MP article URL (https://mp.weixin.qq.com/s/… or long URL with __biz) |
tikhub_post_api_v1_wechat_mp_v2_fetch_article_statsGet WeChat MP Article StatsInspect
Get WeChat MP Article Stats Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| url | Yes | 公众号文章链接(https://mp.weixin.qq.com/s/… 或带 __biz 的长链)/WeChat MP article URL (https://mp.weixin.qq.com/s/… or long URL with __biz) |
tikhub_post_api_v1_wechat_mp_v2_fetch_article_stats_h5Get WeChat MP Article Stats (H5)Inspect
Get WeChat MP Article Stats (H5) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| url | Yes | 公众号文章链接(https://mp.weixin.qq.com/s/… 或带 __biz 的长链)/WeChat MP article URL (https://mp.weixin.qq.com/s/… or long URL with __biz) | |
| comment_id | No | 文章的评论 id(可选,**性能捷径**):不传时上游要先抓并解析整篇文章 HTML 才能拿到它,约占本接口耗时的一半;已有该值时传进来可显著加快。取自 /fetch_article_detail 或 /fetch_article_detail_h5 响应的 `$.data.content.comment_id`/Article comment id (optional, performance shortcut): when omitted, upstream must fetch and parse the whole article HTML to obtain it, which accounts for about half of this endpoint's latency |
tikhub_post_api_v1_wechat_mp_v2_fetch_comment_repliesGet WeChat MP Comment RepliesInspect
Get WeChat MP Comment Replies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | |
| url | Yes | 公众号文章链接(https://mp.weixin.qq.com/s/…)/WeChat MP article URL (https://mp.weixin.qq.com/s/…) | |
| offset | No | 回复翻页偏移,首页 0;has_more=true 时传上次返回的 next_offset/Reply pagination offset, 0 for first page; pass next_offset from the previous response when has_more=true | |
| comment_id | No | 文章的评论 id(可选,**性能捷径**):不传时上游要先抓并解析整篇文章 HTML 才能拿到它,约占本接口耗时的一半;已有该值时传进来可显著加快。取自 /fetch_article_detail 或 /fetch_article_detail_h5 响应的 `$.data.content.comment_id`/Article comment id (optional, performance shortcut): when omitted, upstream must fetch and parse the whole article HTML to obtain it, which accounts for about half of this endpoint's latency | |
| content_id | No | 目标一级评论的 content_id(纯数字),不传则自动取第一条有回复的评论/content_id (numeric) of the target first-level comment; defaults to the first comment that has replies |
tikhub_post_api_v1_wechat_search_v2_fetch_searchWeChat Universal SearchInspect
WeChat Universal Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始搜索响应;False=精简解析结构/True=raw search response; False=simplified parsed structure | |
| sort | No | 排序(结果页「排序」下拉,综合与各垂类通用):不限(相关性) default/0 / 最新(发布时间降序) latest/1 / 最热(点赞降序) hot/2,字符串键或整数均可/Sort (result page 'sort' dropdown, common to all verticals): default/0 (relevance) / latest/1 (newest) / hot/2 (most liked); string key or integer | |
| cursor | No | 翻页游标:首页留空;翻页时把上一页响应返回的 cursor 原样传回/Pagination cursor: leave empty for the first page; for the next page pass back the cursor returned in the previous response | |
| offset | No | 首页传 0;翻页请用 cursor(只传 offset 无效,每页都回到第一页)/Pass 0 for the first page; use cursor to paginate (offset alone does not work — it returns the first page every time) | |
| keyword | Yes | 搜索关键词(1-100 字)/Search keyword (1-100 chars) | |
| publish_time | No | 发布时间(结果页「时间」下拉,通用):不限 all/0 / 最近一天 day/1 / 最近七天 week/2 / 最近半年 half_year/3,字符串键或整数均可/Publish time (result page 'time' dropdown, common): all/0 / day/1 / week/2 / half_year/3; string key or integer | |
| business_type | No | 垂类字符串键(共 18 个)。**实测有结果**:综合 all / 公众号·服务号·视频号 account / 文章 article / 视频 video / 表情 sticker。其余键(underline / encyclopedia / live_stream / comment / listen / news / photos / book / moments / image / mini_game / weixin_index / ai_search)由微信服务端按账号与地区下发,当前实测恒返回空结果(count=0 + no_more 文案,仍按一次正常调用计费)。当前账号真正可用的 tab 以综合搜索响应里的 categories 为准;传列表外的值直接报错(422)/Vertical key (18 total). **Verified to return data**: all / account / article / video / sticker. The rest (underline / encyclopedia / live_stream / comment / listen / news / photos / book / moments / image / mini_game / weixin_index / ai_search) are gated server-side per account & region and currently always come back empty (count=0 plus a no_more message — still billed as a normal call). Use the `categories` field of an `all` search for the authoritative per-account tab list. Values outside this list are rejected (422) |
tikhub_post_api_v1_wechat_search_v2_fetch_search_videos搜视频号视频(时长/排序/时间筛选)/WeChat Channels Video SearchInspect
搜视频号视频(时长/排序/时间筛选)/WeChat Channels Video Search Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | True=原始搜索响应;False=精简解析结构/True=raw search response; False=simplified parsed structure | |
| sort | No | 排序:不限(相关性) default/0 / 最新(发布时间降序) latest/1 / 最热(点赞降序) hot/2,字符串键或整数均可/Sort: default/0 (relevance) / latest/1 (newest) / hot/2 (most liked); string key or integer | |
| cursor | No | 翻页游标,用法同综合搜索:首页留空;翻页时把上一页响应返回的 cursor 原样传回/Pagination cursor, same as universal search: leave empty for the first page; pass back the cursor from the previous response | |
| offset | No | 首页传 0;翻页请用 cursor(只传 offset 无效)/Pass 0 for the first page; use cursor to paginate (offset alone does not work) | |
| keyword | Yes | 搜索关键词(1-100 字)/Search keyword (1-100 chars) | |
| duration | No | 时长档(video 垂类专属):不限 all/0 / 短(<5min) short/1 / 中(5-10min) medium/2 / 长(20min+) long/3,字符串键或整数均可/Duration tier (Channels video only): all/0 / short/1 (<5min) / medium/2 (5-10min) / long/3 (20min+); string key or integer | |
| publish_time | No | 发布时间:不限 all/0 / 最近一天 day/1 / 最近七天 week/2 / 最近半年 half_year/3,字符串键或整数均可/Publish time: all/0 / day/1 / week/2 / half_year/3; string key or integer |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_core_dataGet PGY blogger core data trendInspect
Get PGY blogger core data trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID | |
| business | No | 笔记口径 0=日常笔记(默认) 1=合作笔记/Note scope | |
| date_type | No | 时间范围 1=近30日(默认) 2=近90日/Date range | |
| note_type | No | 笔记类型 3=图文+视频(默认) 1=图文 2=视频/Note type | |
| advertise_switch | No | 流量类型 1=全部(含合作) 0=仅自然流量/Traffic type |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_data_summaryGet PGY blogger data summaryInspect
Get PGY blogger data summary Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID | |
| business | No | 笔记口径 0=日常笔记(默认) 1=合作笔记/Note scope |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_detailGet PGY blogger detailInspect
Get PGY blogger detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_fans_historyGet PGY blogger fans growth historyInspect
Get PGY blogger fans growth history Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID | |
| date_type | No | 时间范围 1=近30日(默认) 2=近60日/Date range: 1=last 30d, 2=last 60d | |
| increase_type | No | 曲线口径 1=粉丝总量(默认,累计) 2=粉丝增量(每日新增)/Curve: 1=total, 2=daily increment |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_fans_profileGet PGY blogger fans profileInspect
Get PGY blogger fans profile Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_fans_summaryGet PGY blogger fans summaryInspect
Get PGY blogger fans summary Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_filter_optionsGet PGY blogger filter optionsInspect
Get PGY blogger filter options Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_list蒲公英笔记博主广场(找博主/选号)/PGY note blogger squareInspect
蒲公英笔记博主广场(找博主/选号)/PGY note blogger square Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| coop | No | 合作笔记数据筛选/Sponsored note metric filters | |
| fans | No | 粉丝画像筛选/Fans profile filters | |
| goal | No | 合作目标筛选/Cooperation goal filters | |
| live | No | 直播数据筛选/Live metric filters | |
| note | No | 日常笔记数据筛选/Organic note metric filters | |
| sort | No | 排序方向 desc/asc | |
| flags | No | 开关类筛选/Boolean flag filters | |
| column | No | 排序字段,共 34 个,见接口说明的排序字段表/Sort column, 34 options, see endpoint docs | |
| blogger | No | 博主属性筛选/Blogger attribute filters | |
| keyword | No | 搜索词;空=只筛选不搜索/Keyword | |
| page_num | No | 页码,1-250(上游只放出前 5000 条)/Page, 1-250 | |
| page_size | No | 每页数量,1-20(网页固定 20,建议保持 20)/Page size, 1-20 | |
| search_type | No | 1=按笔记关键词找博主(默认) 0=按昵称搜/Search mode | |
| similar_word | No | 配合 similar_user_id 的博主昵称,仅用于回显、不影响结果/Nickname echo for similar_user_id; does not affect results | |
| brand_user_id | No | 品牌方/广告主用户ID,可不填/Brand user ID, optional | |
| similar_user_id | No | 找相似博主:填一个博主的 userId,返回与他相似的博主,**并且可以叠加下面所有筛选**(这是它与 /get_blogger_similar 的关键区别)/Find similar bloggers; unlike /get_blogger_similar it can be combined with all filters below |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_notesGet PGY blogger note casesInspect
Get PGY blogger note cases Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID | |
| note_type | No | 笔记类型 4=全部类型(默认) 3=合作笔记 1=图文 2=视频/Note type | |
| page_size | No | 每页数量,1-8(蒲公英网页固定 8)/Page size, 1-8 (fixed at 8 on PGY web) | |
| order_type | No | 排序 1=最新发布(默认) 2=阅读最多 3=互动最多/Sort | |
| content_tag | No | 按内容类目筛选,如 美妆;取值见博主详情的 contentTags/Filter by content tag | |
| feature_tag | No | 按内容特征筛选,如 韩系;取值见博主详情的 featureTags/Filter by feature tag | |
| page_number | No | 页码,从 1 开始/Page number, from 1 | |
| advertise_switch | No | 流量类型 1=全部(含商业合作) 0=仅自然流量/Traffic type | |
| is_third_platform | No | 1=只看跨域合作笔记 0=不限(默认)/Cross-platform notes only |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_notes_rateGet PGY blogger performance metricsInspect
Get PGY blogger performance metrics Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID | |
| business | No | 笔记口径 0=日常笔记(默认) 1=合作笔记/Note scope: 0=organic, 1=sponsored | |
| date_type | No | 时间范围 1=近30日(默认) 2=近90日/Date range: 1=last 30d, 2=last 90d | |
| note_type | No | 笔记类型 3=图文+视频(默认) 1=图文 2=视频/Note type | |
| advertise_switch | No | 流量类型 1=全部(含合作) 0=仅自然流量/Traffic type |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_notes_v2Get PGY blogger note cases v2 (cross-platform)Inspect
Get PGY blogger note cases v2 (cross-platform) Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 博主用户ID/Blogger user ID | |
| note_type | No | 笔记类型 0=全部类型(默认) 1=图文 2=视频/Note type | |
| page_size | No | 每页数量,1-8(蒲公英网页固定 8)/Page size, 1-8 (fixed at 8 on PGY web) | |
| order_type | No | 排序 1=最新发布(默认) 2=阅读最多 3=互动最多/Sort | |
| page_number | No | 页码,从 1 开始/Page number, from 1 |
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_similarGet PGY similar bloggersInspect
Get PGY similar bloggers Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 目标博主用户ID/Target blogger user ID | |
| page_num | No | 页码,从 1 开始/Page | |
| page_size | No | 每页数量,1-4(网页固定 4)/Page size, 1-4 |
tikhub_post_api_v1_xiaohongshu_pgy_get_content_squarePGY content square leaderboardsInspect
PGY content square leaderboards Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| fans | No | 【仅榜 4】创作者粉丝量区间/Creator fans range, board 4 only | |
| price | No | 【仅榜 4】创作者报价/Creator price, board 4 only | |
| theme | No | 【榜 2/4/5/7/8】题材名/Theme | |
| biz_type | Yes | 榜单 1=小红书热门 2=产品种草 3=电商推广 4=蒲公英合作 5=客资收集 6=电商热门 7=种草直达 8=应用推广/Leaderboard | |
| category | No | 【仅榜 1】类目,格式「一级#二级」,如 "内容类目#美妆"/Board 1 only | |
| industry | No | 【榜 2/3/4/5/6/7/8】所属行业名,取值集因榜而异/Industry, values differ per board | |
| order_by | No | 排序字段,留空=用该榜默认排序/Sort field, empty=board default | |
| page_num | No | 页码;每个榜固定只有 100 条/Page; each board has only 100 items | |
| note_type | No | 内容类型 1=图文 2=视频/Content type | |
| page_size | No | 每页数量,1-34(网页固定 34)/Page size, 1-34 | |
| placement | No | 【榜 2/3/5/7/8】流量场域 1=发现 2=搜索 3=视频内流/Traffic placement | |
| date_range | No | 统计窗口:近 3/7/14/30 日/Date window in days | |
| author_type | No | 【仅榜 4】1=蒲公英博主 2=明星/Board 4 only | |
| search_word | No | 关键词,留空=看整榜;支持英文逗号分隔批量搜/Keyword, comma-separated for batch | |
| content_type | No | 内容来源 1=博主合作 2=明星合作 3=员工 5=买手 6=专业号 11=主理人 -1=用户/Content source | |
| sub_biz_type | No | 【仅榜 8】1=应用下载 2=小程序推广 3=应用唤起(默认)/Board 8 only | |
| marketing_target | No | 【仅榜 3】3=商品推广 8=直播推广/Board 3 only |
tikhub_post_api_v1_xiaohongshu_pgy_get_keyword_dailyPGY keyword daily trendInspect
PGY keyword daily trend Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| search_word | Yes | 关键词,如 面膜/Keyword |
tikhub_post_api_v1_xiaohongshu_pgy_get_keyword_statPGY keyword overviewInspect
PGY keyword overview Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| search_word | Yes | 关键词,如 面膜/Keyword |
tikhub_post_api_v1_xiaohongshu_pgy_get_live_blogger_listPGY live blogger squareInspect
PGY live blogger square Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ecom | No | 电商转化力/E-commerce conversion filters | |
| fans | No | 粉丝购买力/Fans purchasing power filters | |
| live | No | 直播投入度 + 表现力/Live activity & performance filters | |
| seed | No | 翻页种子:首页传 0,之后回传上一页返回的 seed/Paging seed, echo back from previous page | |
| buyer | No | 买手天团 + 内容人设/Buyer group & persona filters | |
| flags | No | 平台推荐开关/Platform recommendation flags | |
| category | No | 合作品类/Category filters | |
| page_num | No | 页码,1-250(上游只放出前 5000 条)/Page, 1-250 | |
| nick_name | No | 按博主昵称搜索/Search by nickname | |
| page_size | No | 每页数量,1-20(网页固定 20)/Page size, 1-20 |
tikhub_post_api_v1_xiaohongshu_pgy_get_note_commentsGet PGY note featured commentsInspect
Get PGY note featured comments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | 笔记ID/Note ID |
tikhub_post_api_v1_xiaohongshu_pgy_get_note_componentsGet PGY note componentsInspect
Get PGY note components Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | 笔记ID/Note ID |
tikhub_post_api_v1_xiaohongshu_pgy_get_note_detailGet PGY note detailInspect
Get PGY note detail Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | 笔记ID/Note ID |
tikhub_post_api_v1_youtube_web_v2_get_video_streams_v3Recommended: download URLs with your fixed-exit proxyInspect
Recommended: download URLs with your fixed-exit proxy Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| itags | No | 所需格式编号,1–4 个不重复的数字字符串 / 1–4 unique numeric format IDs | |
| video_id | Yes | 11 位 YouTube 视频 ID / 11-character YouTube video ID | |
| proxy_url | Yes | 固定公网出口的 HTTP 代理,必须包含端口 / HTTP proxy with a fixed public exit and explicit port | |
| verify_download | No | 是否尝试读取各流前 1 KiB;不代表完整下载验证 / Probe up to 1 KiB per stream, not the full file |
tikhub_post_api_v1_zhihu_web_fetch_scholar_search_v3Get Zhihu Scholar Search V3Inspect
Get Zhihu Scholar Search V3 Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 过滤字段/Filter Fields | |
| limit | No | 每页论文数量/Number of papers per page | |
| offset | No | 偏移量/Offset | |
| keyword | Yes | 搜索关键词/Search Keywords |
tinyfish_getTinyFish SearchInspect
Search the web, news, or research papers and return ranked results with snippets and source URLs. Use Fetch when full page content is required. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination, starting from 0 (max 10) | |
| fetch | No | JSON-encoded fetch configuration object. | |
| query | Yes | Search query | |
| purpose | No | Why this search is being run — the underlying goal or task the results will be used for. Used to better rank results against your intent. | |
| language | No | Language code for result language | |
| location | No | Country code for geo-targeted results | |
| after_date | No | Return results after this date (YYYY-MM-DD) | |
| before_date | No | Return results before this date (YYYY-MM-DD) | |
| domain_type | No | Type of search to perform: "web" for standard results, "news" for news articles, "research_paper" for academic papers. Defaults to "web". | |
| pub_year_max | No | Return research papers published on or before this year (0-9999, inclusive). Only supported for domain_type=research_paper. | |
| pub_year_min | No | Return research papers published on or after this year (0-9999, inclusive). Only supported for domain_type=research_paper. | |
| exclude_domains | No | Comma-separated list of domains to exclude from results | |
| include_domains | No | Comma-separated list of domains to restrict results to | |
| recency_minutes | No | Return results from the past N minutes (1 to 5,256,000). | |
| include_thumbnail | No | When "true", each result includes a thumbnail_url when available. Defaults to false. |
tinyfish_postTinyFish FetchInspect
Fetch content from 1 to 10 known webpage URLs as Markdown, HTML, or a document tree. Each URL is processed independently; inspect both results and errors. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Fetch content from 1 to 10 known webpage URLs as Markdown, HTML, or a document tree. Each URL is processed independently; inspect both results and errors. |
tinyfish_post_v1_automation_runTinyFish Web Automation AgentInspect
Execute a natural-language goal on a website and return the final result through the synchronous automation endpoint. Usage is measured by the reported number of steps. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Execute a natural-language goal on a website and return the final result through the synchronous automation endpoint. Usage is measured by the reported number of steps. |
treg_get_call_companyenrich_companies_autocompleteResolve a company name to its domain (free autocomplete)Inspect
Returns a list of companies matching the given partial domain name — up to 10 companies per request Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | partial domain or company name |
treg_get_call_companyenrich_companies_enrichEnrich a company by domainInspect
Enriches a company using its domain name as lookup parameter Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | company domain, no protocol or www; max 1024 chars |
treg_get_call_companyenrich_companies_getA company record by CompanyEnrich idInspect
Gets a company information by its CompanyEnrich ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | the UUID returned in the `id` field of any enrich or search result |
treg_get_call_companyenrich_companies_workforceCompany headcount by department, with historyInspect
Returns workforce insights for a single company — observed employee count, range bucket, and headcounts grouped by root departments Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | CompanyEnrich company UUID — supply EXACTLY ONE of domain or id | |
| domain | No | company domain — supply EXACTLY ONE of domain or id |
treg_get_call_companyenrich_geo_country_getGet a country by ISO codeInspect
Searches a country by its ISO 3166-1 alpha-2 code Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| countryCode | Yes | ISO 3166-1 alpha-2 code |
treg_get_call_companyenrich_geo_regionsList world regionsInspect
Returns all regions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
treg_get_call_companyenrich_industries_listList the industry taxonomy with NAICS codesInspect
Obtain a list of all company industries Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
treg_get_call_companyenrich_keywords_autocompleteAutocomplete company keywordsInspect
Lookup keywords Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | partial keyword |
treg_get_call_companyenrich_people_emailFind a person's work email by person id (beta)Inspect
Resolves a work email address for a single person on a specific domain Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | the numeric CompanyEnrich person id, from a people search or lookup | |
| domain | No | which employer to resolve the address on; must match one of the person's experiences. Omit it and the provider tries their current employers in seniority order |
treg_get_call_companyenrich_people_getA person record by CompanyEnrich idInspect
Gets person information by its CompanyEnrich ID Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | the numeric `id` from a people search, lookup or email response |
treg_get_call_companyenrich_positions_autocompleteAutocomplete job titlesInspect
Lookup positions Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | partial job title |
treg_get_call_companyenrich_technologies_autocompleteAutocomplete technology namesInspect
Lookup technologies Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | partial technology name |
treg_get_call_enrichlayer_email_disposable_checkDisposable email checkInspect
Check whether an email domain is disposable. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| Yes |
treg_get_call_predictleads_companies_connectionsA company's partners, customers and investors by domainInspect
Returns a list of company's Connections. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | default 100, max 1000 — raising it costs nothing extra | |
| categories | No | comma-separated connection categories, e.g. investor,customer,partner,vendor | |
| first_seen_at_from | No | ISO 8601 date | |
| first_seen_at_until | No | ISO 8601 date | |
| company_id_or_domain | Yes | company domain or PredictLeads company UUID |
treg_get_call_predictleads_companies_financing_eventsA company's funding rounds by domainInspect
Returns a list of company's Financing Events. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | default 100, max 1000 — raising it costs nothing extra | |
| first_seen_at_from | No | ISO 8601 date — filters on when PredictLeads first recorded the round, not when the round happened | |
| first_seen_at_until | No | ISO 8601 date — filters on first-recorded time, not the round date | |
| company_id_or_domain | Yes | company domain or PredictLeads company UUID |
treg_get_call_predictleads_companies_news_eventsA company's classified news events by domainInspect
Returns a list of company's News Events. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | default 100, max 1000 — raising it costs nothing extra | |
| location | No | country name or US state name/abbreviation | |
| categories | No | comma-separated event categories, e.g. partners_with,hires,opens_new_location,receives_financing | |
| found_at_from | No | ISO 8601 date — filters on found_at, when PredictLeads found the event, not when the event happened: the polling dial for 'what changed since my last run', not a recency filter for events; a recently found row can describe an event months or years old | |
| found_at_until | No | ISO 8601 date — filters on found_at (discovery time), not the event date | |
| company_id_or_domain | Yes | company domain or PredictLeads company UUID |
treg_get_call_predictleads_companies_technology_detectionsA company's tech stack by domain, with evidenceInspect
Returns Technologies used by a specific Company as a list of Technology Detections. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | default 100, max 1000 — raising it costs nothing extra | |
| last_seen_at_from | No | ISO 8601 date | |
| first_seen_at_from | No | ISO 8601 date — use it to get only NEWLY adopted technologies | |
| last_seen_at_until | No | ISO 8601 date | |
| first_seen_at_until | No | ISO 8601 date | |
| company_id_or_domain | Yes | company domain or PredictLeads company UUID |
treg_post_call_companyenrich_companies_enrich_by_propertiesEnrich a company by name or social profileInspect
Enriches a company using its properties — best match is used in case of ambiguity Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON request body for Enrich a company by name or social profile. See individual field descriptions for input requirements. |
treg_post_call_companyenrich_companies_search_countCount companies matching a filter (free)Inspect
Returns the total count of companies matching the given search criteria without retrieving the actual results Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Returns the total count of companies matching the given search criteria without retrieving the actual results |
treg_post_call_companyenrich_companies_similar_countCount lookalike companies for a seed (free)Inspect
Returns the total count of similar companies matching the given search criteria without retrieving the actual results Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Returns the total count of similar companies matching the given search criteria without retrieving the actual results |
treg_post_call_companyenrich_geo_cities_searchSearch cities by nameInspect
Searches cities by name or country codes — returns up to 100 cities per page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON request body for Search cities by name. See individual field descriptions for input requirements. |
treg_post_call_companyenrich_geo_countries_searchSearch countries by nameInspect
Searches countries by name — returns up to 100 countries per page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON request body for Search countries by name. See individual field descriptions for input requirements. |
treg_post_call_companyenrich_geo_states_searchSearch states and provincesInspect
Searches states by name or country codes — returns up to 100 states per page Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON request body for Search states and provinces. See individual field descriptions for input requirements. |
treg_post_call_crawl4ai_medium_posts_listList public Medium RSS postsInspect
The latest posts of a Medium tag, author or publication, from Medium's public RSS feed: title, link (the ?source= tracking query removed), author, publication time, categories, and the first 300 characters of the summary. Set exactly one of tag (a tag slug such as rust), author (a Medium username without the @) or publication (a publication slug); tag wins when several are set. limit caps the rows; Medium's feed carries about 10 items, so a larger limit gives no more.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The latest posts of a Medium tag, author or publication, from Medium's public RSS feed: title, link (the ?source= tracking query removed), author, publication time, categories, and the first 300 characters of the summary. Set exactly one of `tag` (a tag slug such as rust), `author` (a Medium username without the @) or `publication` (a publication slug); `tag` wins when several are set. `limit` caps the rows; Medium's feed carries about 10 items, so a larger limit gives no more. Usage limits: Choose exactly one of tag, author or publication. Public RSS usually has about 10 posts; short summaries only, no paywalled full text. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_crawl4ai_packages_package_infoGet npm, PyPI or crates.io package metadataInspect
One row of facts about a package from its registry's public JSON: latest version and when it was published, description, license, homepage, repository, downloads (crates.io only) and the number of dependencies. ecosystem is npm, pypi or crates; name is the package.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | One row of facts about a package from its registry's public JSON: latest version and when it was published, description, license, homepage, repository, downloads (crates.io only) and the number of dependencies. `ecosystem` is npm, pypi or crates; `name` is the package. Usage limits: Supports npm, pypi and crates. Downloads are available for crates.io only. License metadata is not a license-compliance assessment. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_crawl4ai_remoteok_search_jobsSearch Remote OK job listingsInspect
The remote jobs listed on Remote OK right now, from its public API: title, company, tags, location, salary range, date, the job's Remote OK link, the apply link and the first 300 characters of the description. tag keeps jobs with that tag (rust, design, …), keyword keeps jobs whose title, company or tags mention it; limit caps the rows. Source: Remote OK.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The remote jobs listed on Remote OK right now, from its public API: title, company, tags, location, salary range, date, the job's Remote OK link, the apply link and the first 300 characters of the description. `tag` keeps jobs with that tag (rust, design, …), `keyword` keeps jobs whose title, company or tags mention it; `limit` caps the rows. Source: Remote OK. Usage limits: Query-time public job listings with source and application links. Descriptions are limited to 300 characters; availability can change. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_crawl4ai_research_search_papersSearch arXiv paper metadataInspect
Papers on arXiv that match a query, from the arXiv API: title, authors, the first 500 characters of the abstract, the paper's page, the PDF, submission time and primary category. sort is relevance or date; category narrows to one arXiv category such as cs.LG; limit up to 100.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Papers on arXiv that match a query, from the arXiv API: title, authors, the first 500 characters of the abstract, the paper's page, the PDF, submission time and primary category. `sort` is relevance or date; `category` narrows to one arXiv category such as cs.LG; `limit` up to 100. Usage limits: Up to 100 paper metadata records; abstracts are limited to 500 characters. Return source/PDF links; full-paper redistribution requires separate license checks. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_crawl4ai_shopify_store_productsList a Shopify store's public productsInspect
The products a Shopify store lists at its public /products.json, one row per product: title, handle, product URL, vendor, product type, the lowest and the highest variant price as the store's own text (no currency code: the store's default currency), whether any variant is in stock, the variant count, the first image, the tags, and the update time. store is the store's host (allbirds.com) or its URL, with a market path (www.x.com/en-ca) when the store has one; limit is products per page (up to 250); page picks a later page. A store with products.json off answers 404 or HTML: no rows.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The products a Shopify store lists at its public /products.json, one row per product: title, handle, product URL, vendor, product type, the lowest and the highest variant price as the store's own text (no currency code: the store's default currency), whether any variant is in stock, the variant count, the first image, the tags, and the update time. `store` is the store's host (allbirds.com) or its URL, with a market path (www.x.com/en-ca) when the store has one; `limit` is products per page (up to 250); `page` picks a later page. A store with products.json off answers 404 or HTML: no rows. Usage limits: Public products.json only; disabled stores return no rows. Up to 250 products/page. Price strings lack a currency code. No orders or customer data. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_crawl4ai_stackoverflow_search_questionsSearch Stack Overflow questions by tagInspect
Questions on Stack Overflow with a tag, from the Stack Exchange API: title, link, score, answer count, views, whether an answer is accepted, time, tags, author, id and the first 300 characters of the question. sort is activity, votes, creation, hot, week or month; limit up to 100 in one call.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Questions on Stack Overflow with a tag, from the Stack Exchange API: title, link, score, answer count, views, whether an answer is accepted, time, tags, author, id and the first 300 characters of the question. `sort` is activity, votes, creation, hot, week or month; `limit` up to 100 in one call. Usage limits: Tag-based question discovery, not full answers. Up to 100 questions. Preserve source URLs, author attribution and the applicable CC BY-SA license. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_crawl4ai_steam_app_detailGet Steam game details and regional pricesInspect
One game on Steam: name, price and discount in the chosen store region, developers, publishers, release date, genres, feature tags, Metacritic score, the review counts and verdict (Very Positive, …), platforms and the short description. app is the Steam app id or a store URL; country the price region (us, de, …).
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | One game on Steam: name, price and discount in the chosen store region, developers, publishers, release date, genres, feature tags, Metacritic score, the review counts and verdict (Very Positive, …), platforms and the short description. `app` is the Steam app id or a store URL; `country` the price region (us, de, …). Usage limits: Prices depend on the selected store country and are query-time snapshots. No purchases, reservations or account access. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_crawl4ai_web_feed_readAny RSS or Atom feedInspect
The items of any RSS 2.0 or Atom feed: title, link, publication time, author, the first 300 characters of the summary, and the item's id. Give the feed's url; limit caps the rows (up to 200). Columns: title, link, published, author, summary, id.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON request body for Any RSS or Atom feed. See individual field descriptions for input requirements. |
treg_post_call_crawl4ai_weworkremotely_search_jobsSearch We Work Remotely job feedsInspect
The newest jobs in one We Work Remotely category feed: job title, company, the job's page, region, the feed's category, the job type (Full-Time or Contract; the programming feed carries none), publication time and the first 300 characters of the description. category picks the feed: programming, design, devops, support, sales, product, management, other or all (other sits behind a Cloudflare challenge today: no rows, no charge). keyword keeps jobs whose title or company mentions it. limit caps the rows (up to 100). One fetch per run.
Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The newest jobs in one We Work Remotely category feed: job title, company, the job's page, region, the feed's category, the job type (Full-Time or Contract; the programming feed carries none), publication time and the first 300 characters of the description. `category` picks the feed: programming, design, devops, support, sales, product, management, other or all (`other` sits behind a Cloudflare challenge today: no rows, no charge). `keyword` keeps jobs whose title or company mentions it. `limit` caps the rows (up to 100). One fetch per run. Usage limits: Up to 100 feed items. The currently blocked other category is excluded. Keep source/job links; programming feeds may omit job type. Draft retail price: USD 0.000150/successful call, equal to the TREG catalog rate; no markup. |
treg_post_call_dropleads_people_searchSearch peopleInspect
Search the Dropleads people database with company, role, location and intent filters. Free search does not make enrich/reveal endpoints free. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Search the Dropleads people database with company, role, location and intent filters. Free search does not make enrich/reveal endpoints free. |
treg_post_call_hlrlookup_people_phone_validateValidate and format a phone numberInspect
Validates the number and returns number type, issuing network and formatted output without a live HLR lookup. Formatting and number-range information only; no live network reachability. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Validates the number and returns number type, issuing network and formatted output without a live HLR lookup. Formatting and number-range information only; no live network reachability. |
treg_post_call_icypeas_people_search_countCount people matching a search (free)Inspect
How many people match a query, before you pay to read any of them Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | How many people match a query, before you pay to read any of them |
treg_post_call_valyu_economics_indicators_searchSearch economic indicatorsInspect
Find BLS and World Bank statistics. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON request body for Search economic indicators. See individual field descriptions for input requirements. |
treg_post_call_valyu_health_references_searchSearch FDA labels and WHO health referencesInspect
Find FDA drug labels and WHO Global Health Observatory data. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Find FDA drug labels and WHO Global Health Observatory data. Usage limits: Restricted to FDA-label and WHO sources, short responses, 1-10 results. Billed from total_deduction_dollars, not a flat per-call maximum. Reference search only. Draft retail price: at cost from the upstream USD meter; no markup. Only the documented data sources are allowed. Request contract: include all six declared body fields. Send search_type=proprietary, response_length=short, and the exact max_price and included_sources shown in the example; these are constrained source settings. |
treg_post_call_valyu_health_trials_searchSearch clinical trial recordsInspect
Find clinical study protocols and outcomes. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Find clinical study protocols and outcomes. Usage limits: Restricted clinical-trial source, short responses, 1-10 results. Billed from total_deduction_dollars; trial records are not efficacy or safety certification. Draft retail price: at cost from the upstream USD meter; no markup. Only the documented data sources are allowed. Request contract: include all six declared body fields. Send search_type=proprietary, response_length=short, and the exact max_price and included_sources shown in the example; these are constrained source settings. |
typesafe_post_v1_systemoneTypeSafe Text and Image DecisionsInspect
Evaluate text with Choice, Score and Noul using pinned Jev versions. Disabled review profile; images and long-context opt-ins are excluded. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON Base64 images, text and optional long context on pinned Jev 1.14/1.13. Box requires 1.14 and an image. Multipart and model aliases remain excluded. Long-context gateway adaptation and target acceptance pending. | |
| Idempotency-Key | Yes | Required OpenAny idempotency key: 1–128 printable ASCII bytes, excluding spaces/control characters. Reuse only for the same request; this local contract is stricter than PageIndex's upstream 255-character limit. | |
| TypeSafe-Danger-Zone-Images | No | Experimental images opt-in. Required when assets is nonempty or a Box question is used; optional for text-only requests. Gateway adaptation confirmed by user; target runtime enforcement not independently verified. | |
| TypeSafe-Danger-Zone-Long-Context | No | Optional long-context opt-in for pinned Jev 1.14.0 and 1.13.0. Send the STRING true to use the official 262k per-request and per-question limits. Omit for default 64k per-request/32k per-question. Same input-token price; output free. This header may accompany the Images header. Gateway long-context acceptance pending. |
uniswap_get_v1_ordersUniswap Get gasless order statusInspect
Get gasless order status. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort query. For example: `sort=gt(UNIX_TIMESTAMP)`, `sort=between(1675872827, 1675872930)`, or `lt(1675872930)`. | |
| limit | No | Native limit parameter. | |
| cursor | No | Native cursor parameter. | |
| filler | No | Filter by filler address. | |
| orderId | No | A transaction hash for an order. `orderId` or `orderIds` must be provided, but not both. | |
| sortKey | No | Order the query results by the sort key. | |
| swapper | No | Filter by swapper address. | |
| orderIds | No | A list of comma separated orderIds (transaction hashes). `orderId` or `orderIds` must be provided, but not both. | |
| orderType | No | The UniswapX order type to retrieve. | |
| orderStatus | No | Filter by order status. | |
| x-agent-info | No | x-agent-info |
uniswap_get_v1_plan_planidUniswap Get an execution planInspect
Get an execution plan. Uses the native public Uniswap HTTP contract. Tracks a multi-step execution plan; HTTP success is not proof of on-chain completion. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | The unique identifier of the plan to retrieve. | |
| forceRefresh | No | Whether to re-check step statuses and re-quote the steps not yet proved. Defaults to false. Completed plans cannot be refreshed. | |
| x-agent-info | No | x-agent-info |
uniswap_get_v1_supported_chainsUniswap Get supported chainsInspect
Get supported chains. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| x-agent-info | No | x-agent-info |
uniswap_get_v1_swappable_tokensUniswap Get bridgable tokensInspect
Get bridgable tokens. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| tokenIn | Yes | Native tokenIn parameter. | |
| x-agent-info | No | x-agent-info | |
| tokenInChainId | Yes | Native tokenInChainId parameter. |
uniswap_get_v1_swapsUniswap Get swap statusInspect
Get swap status. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| chainId | No | Native chainId parameter. | |
| txHashes | No | On-chain transaction hashes. At least one of txHashes or userOpHashes must be provided. | |
| userOpHashes | No | ERC-4337 UserOperation hashes. At least one of txHashes or userOpHashes must be provided. | |
| x-agent-info | No | x-agent-info |
uniswap_get_v1_tokensUniswap Get tokensInspect
Get tokens. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Native sort parameter. | |
| limit | No | Number of ranked tokens to return. Applies only when sort is `tvl` or `volume_24h`. Defaults to 100. | |
| chainId | No | Native chainId parameter. | |
| x-agent-info | No | x-agent-info |
uniswap_patch_v1_plan_planidUniswap Update an execution planInspect
Update an execution plan. Uses the native public Uniswap HTTP contract. Tracks a multi-step execution plan; HTTP success is not proof of on-chain completion. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| planId | Yes | The unique identifier of the plan to update. | |
| x-agent-info | No | x-agent-info |
uniswap_post_lp_check_approvalUniswap Check LP token approvalsInspect
Check LP token approvals. Builds or reads LP operation data; signing and on-chain broadcasting are separate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_lp_claim_feesUniswap Claim LP position feesInspect
Claim LP position fees. Builds or reads LP operation data; signing and on-chain broadcasting are separate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_lp_createUniswap Create a V3 or V4 LP positionInspect
Create a V3 or V4 LP position. Builds or reads LP operation data; signing and on-chain broadcasting are separate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_lp_create_classicUniswap Create a classic (V2) LP positionInspect
Create a classic (V2) LP position. Builds or reads LP operation data; signing and on-chain broadcasting are separate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_lp_decreaseUniswap Decrease an LP positionInspect
Decrease an LP position. Builds or reads LP operation data; signing and on-chain broadcasting are separate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_lp_increaseUniswap Increase an LP positionInspect
Increase an LP position. Builds or reads LP operation data; signing and on-chain broadcasting are separate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_lp_pool_infoUniswap Get pool stateInspect
Get pool state. Builds or reads LP operation data; signing and on-chain broadcasting are separate. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_v1_check_approvalUniswap Check swap approvalsInspect
Check swap approvals. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info | |
| x-permit2-disabled | No | Disables the Permit2 approval flow. When set to `true`, `permitData` is returned as `null` and the header is forwarded to the routing layer for correct gas simulation against the Proxy Universal Router contract. When `false` or omitted, the standard Permit2 approval flow is used. This header is intended for integrators whose infrastructure uses a direct approval-then-swap pattern without Permit2. |
uniswap_post_v1_orderUniswap Create a gasless orderInspect
Create a gasless order. Uses the native public Uniswap HTTP contract. Submits a signed UniswapX order; acceptance is not proof of a fill. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info | |
| x-erc20eth-enabled | No | Enable native ETH input support for UniswapX via ERC20-ETH (EIP-7914). When set to true and `tokenIn` is the native currency address (e.g. `0x0000000000000000000000000000000000000000`), the API may return UniswapX routes that spend native ETH for supported wallets. |
uniswap_post_v1_permissionsUniswap Check token KYC permissionsInspect
Check token KYC permissions. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_v1_planUniswap Create an execution planInspect
Create an execution plan. Uses the native public Uniswap HTTP contract. Tracks a multi-step execution plan; HTTP success is not proof of on-chain completion. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_v1_quoteUniswap Get a quoteInspect
Get a quote. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info | |
| x-api-experimental | No | Requests Guidestar routing. Requires x-universal-router-swapsteps: true. Supported for EXACT_INPUT quotes on Ethereum (1), Base (8453), and Robinhood Chain (4663); any other request, including one without the swap steps header, returns a 400 InputValidationError. A Guidestar request does not fall back to standard routing: if Guidestar cannot produce a quote, the request returns a 404. Guidestar routing is in beta and its behavior may change. Omitting the header or setting it to false keeps standard routing. | |
| x-erc20eth-enabled | No | Enable native ETH input support for UniswapX via ERC20-ETH (EIP-7914). When set to true and `tokenIn` is the native currency address (e.g. `0x0000000000000000000000000000000000000000`), the API may return UniswapX routes that spend native ETH for supported wallets. | |
| x-permit2-disabled | No | Disables the Permit2 approval flow. When set to `true`, `permitData` is returned as `null` and the header is forwarded to the routing layer for correct gas simulation against the Proxy Universal Router contract. When `false` or omitted, the standard Permit2 approval flow is used. This header is intended for integrators whose infrastructure uses a direct approval-then-swap pattern without Permit2. | |
| x-universal-router-version | No | The version of the Universal Router to use for the swap journey. *MUST* be consistent throughout the API calls. |
uniswap_post_v1_swapUniswap Create swap calldataInspect
Create swap calldata. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info | |
| x-permit2-disabled | No | Disables the Permit2 approval flow. When set to `true`, `permitData` is returned as `null` and the header is forwarded to the routing layer for correct gas simulation against the Proxy Universal Router contract. When `false` or omitted, the standard Permit2 approval flow is used. This header is intended for integrators whose infrastructure uses a direct approval-then-swap pattern without Permit2. | |
| x-universal-router-version | No | The version of the Universal Router to use for the swap journey. *MUST* be consistent throughout the API calls. |
uniswap_post_v1_swap_5792Uniswap Create swap EIP 5792 calldataInspect
Create swap EIP 5792 calldata. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info | |
| x-universal-router-version | No | The version of the Universal Router to use for the swap journey. *MUST* be consistent throughout the API calls. |
uniswap_post_v1_swap_7702Uniswap Create swap EIP 7702 calldataInspect
Create swap EIP 7702 calldata. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info | |
| x-erc20eth-enabled | No | Enable native ETH input support for UniswapX via ERC20-ETH (EIP-7914). When set to true and `tokenIn` is the native currency address (e.g. `0x0000000000000000000000000000000000000000`), the API may return UniswapX routes that spend native ETH for supported wallets. | |
| x-universal-router-version | No | The version of the Universal Router to use for the swap journey. *MUST* be consistent throughout the API calls. |
uniswap_post_v1_wallet_check_delegationUniswap Get wallet delegationsInspect
Get wallet delegations. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
uniswap_post_v1_wallet_encode_7702Uniswap Encode wallet transactionsInspect
Encode wallet transactions. Uses the native public Uniswap HTTP contract. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | body | |
| x-agent-info | No | x-agent-info |
wikimedia_get_analytics_pageviews_project_article_start_endWikipedia Article PageviewsInspect
Get daily article pageviews across all access methods, counting user traffic. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | End date in YYYYMMDD00 format. | |
| start | Yes | Start date in YYYYMMDD00 format. | |
| article | Yes | Article title with spaces replaced by underscores. | |
| project | Yes | Wikipedia project domain, such as en.wikipedia.org. |
wikimedia_get_analytics_top_project_year_month_dayWikipedia Most-Viewed ArticlesInspect
Get the most-viewed articles for a Wikipedia project on a given UTC date. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| day | Yes | Two-digit UTC day. | |
| year | Yes | Four-digit UTC year. | |
| month | Yes | Two-digit UTC month. | |
| project | Yes | Wikipedia project domain, such as en.wikipedia.org. |
wikimedia_get_backlinksWikipedia Article BacklinksInspect
List English Wikipedia articles that link to the specified article. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| list | Yes | Set to backlinks. | |
| action | Yes | Set to query. | |
| format | Yes | Set to json. | |
| bllimit | Yes | Maximum number of backlinks per request. | |
| bltitle | Yes | Title of the article receiving links. | |
| continue | No | Pass the continue value from the previous response to retrieve the next page. | |
| blcontinue | No | Pass the blcontinue value from the previous response to retrieve the next page. | |
| blnamespace | Yes | Set to 0. | |
| formatversion | Yes | Set to 2. |
wikimedia_get_category_membersWikipedia Category MembersInspect
List pages and subcategories in an English Wikipedia category. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| list | Yes | Set to categorymembers. | |
| action | Yes | Set to query. | |
| format | Yes | Set to json. | |
| cmlimit | Yes | Maximum number of category members per request. | |
| cmtitle | Yes | Category title including the Category: prefix. | |
| continue | No | Pass the continue value from the previous response to retrieve the next page. | |
| cmcontinue | No | Pass the cmcontinue value from the previous response to retrieve the next page. | |
| formatversion | Yes | Set to 2. |
wikimedia_get_commons_fileWikimedia Commons File DetailsInspect
Get original and thumbnail URLs, dimensions, MIME type, and available creator and license metadata. Check the file page for attribution and reuse terms. Creator metadata may contain HTML. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| prop | Yes | Set to imageinfo. | |
| action | Yes | Set to query. | |
| format | Yes | Set to json. | |
| iiprop | Yes | Set to url|size|mime|extmetadata. | |
| titles | Yes | Commons file title including the File: prefix. | |
| iiurlwidth | Yes | Requested thumbnail width in pixels. | |
| formatversion | Yes | Set to 2. | |
| iiextmetadatafilter | Yes | Set to Artist|LicenseShortName|LicenseUrl. |
wikimedia_get_commons_searchWikimedia Commons File SearchInspect
Search the Commons file namespace by keyword. Pass the returned File: title to Wikimedia Commons File Details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Set to query. | |
| format | Yes | Set to json. | |
| gsrlimit | Yes | Maximum number of files to return. | |
| generator | Yes | Set to search. | |
| gsrsearch | Yes | Search keywords. | |
| gsrnamespace | Yes | Set to 6. | |
| formatversion | Yes | Set to 2. |
wikimedia_get_coordinatesWikipedia Article CoordinatesInspect
Retrieve geographic coordinates for an English Wikipedia article. Results may be empty for articles without coordinates. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| prop | Yes | Request the coordinates page property. | |
| action | Yes | Select the read-only query action. | |
| format | Yes | Return JSON. | |
| titles | Yes | English Wikipedia article title, such as Eiffel Tower. | |
| colimit | Yes | Maximum number of results to return. | |
| continue | No | When paginating, pass the continue value from the previous response if present. | |
| redirects | Yes | Resolve redirects to the canonical article. | |
| cocontinue | No | When paginating, pass the cocontinue value from the previous response if present. | |
| formatversion | Yes | Use JSON format version 2. |
wikimedia_get_external_linksWikipedia Article External LinksInspect
List URLs in an English Wikipedia article that point to external sites. Results may include references and other external links. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| prop | Yes | Request the extlinks page property. | |
| action | Yes | Select the read-only query action. | |
| format | Yes | Return JSON. | |
| titles | Yes | English Wikipedia article title, such as Earth. | |
| ellimit | Yes | Maximum number of results to return. | |
| continue | No | When paginating, pass the continue value from the previous response if present. | |
| redirects | Yes | Resolve redirects to the canonical article. | |
| elcontinue | No | When paginating, pass the elcontinue value from the previous response if present. | |
| formatversion | Yes | Use JSON format version 2. |
wikimedia_get_nearbyWikipedia Nearby ArticlesInspect
Find English Wikipedia articles near a location and return titles, coordinates, and distances in meters. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| list | Yes | Set to geosearch. | |
| action | Yes | Set to query. | |
| format | Yes | Set to json. | |
| gscoord | Yes | Latitude and longitude in latitude|longitude order. | |
| gslimit | Yes | Maximum number of articles to return. | |
| gsradius | Yes | Search radius in meters. | |
| formatversion | Yes | Set to 2. |
wikimedia_get_page_titleWikipedia Article ContentInspect
Retrieve an English Wikipedia article as HTML with its latest revision and text license. When republishing the text, credit Wikipedia contributors, link to the original article and its license, and indicate any changes. Check media licenses separately and sanitize the HTML before rendering it. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Article title or page key. Prefer the key returned by article search and encode it as a single URL path segment. |
wikimedia_get_revision_from_compare_toWikipedia Revision ComparisonInspect
Compare two revisions of the same English Wikipedia article and return a line-by-line diff. Attribute reused text to Wikipedia contributors and link to the source article and its license. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Target revision ID from the same article. | |
| from | Yes | Base revision ID. |
wikimedia_get_revisionsWikipedia Article Revision HistoryInspect
List recent revisions of an English Wikipedia article with revision IDs, UTC timestamps, and edit summaries. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| prop | Yes | Set to revisions. | |
| action | Yes | Set to query. | |
| format | Yes | Set to json. | |
| rvprop | Yes | Set to ids|timestamp|comment. | |
| titles | Yes | English Wikipedia article title. | |
| rvlimit | Yes | Maximum number of revisions to return. | |
| formatversion | Yes | Set to 2. |
wikimedia_get_searchWikipedia Article SearchInspect
Search English Wikipedia by keyword. Results include article titles, page keys, and matching excerpts. When displaying excerpts, credit Wikipedia contributors, link to the original article, and identify the applicable license. Check thumbnail licenses separately. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Search keywords, such as Earth. | |
| limit | No | Maximum number of results to return. OpenAny accepts 1 to 20. Omit this parameter to use the upstream default. |
wikimedia_get_wikidata_entityWikidata Entity DetailsInspect
Look up Wikidata entity labels, descriptions, aliases, statements, or Wikipedia sitelinks by entity ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | Wikidata entity ID, such as Q2. | |
| props | Yes | Fields to retrieve. | |
| action | Yes | Set this parameter to wbgetentities. | |
| format | Yes | Set this parameter to json. | |
| languages | Yes | Language code for localized fields, such as en or zh. |
wikimedia_get_wikidata_entity_searchWikidata Entity SearchInspect
Search Wikidata for entities by label or alias and return their IDs. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | Yes | Maximum number of search results. | |
| action | Yes | Set this parameter to wbsearchentities. | |
| format | Yes | Set this parameter to json. | |
| search | Yes | Entity name or alias. | |
| language | Yes | Search language code, such as en or zh. |
wikimedia_get_wikidata_idWikipedia Article Wikidata IDInspect
Resolve an English Wikipedia article to its linked Wikidata item ID. The wikibase_item field is present only when the article has a linked item. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| prop | Yes | Set to pageprops. | |
| action | Yes | Set to query. | |
| format | Yes | Set to json. | |
| ppprop | Yes | Set to wikibase_item. | |
| titles | Yes | English Wikipedia article title. | |
| redirects | Yes | Set to 1. | |
| formatversion | Yes | Set to 2. |
wikimedia_get_zh_article_enWikipedia Chinese-to-English Article LinkInspect
Find the English Wikipedia title and URL for a known Chinese Wikipedia article. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| prop | Yes | Set this parameter to langlinks. | |
| action | Yes | Set this parameter to query. | |
| format | Yes | Set this parameter to json. | |
| lllang | Yes | Set this parameter to en. | |
| llprop | Yes | Set this parameter to url. | |
| titles | Yes | Chinese Wikipedia article title. | |
| formatversion | Yes | Set this parameter to 2. |
wikimedia_get_zh_article_introChinese Wikipedia Article IntroductionInspect
Retrieve a short plain-text introduction from Chinese Wikipedia. The text is returned in query.pages[].extract. When displaying an extract, credit Wikipedia contributors, link to the original article, and identify the applicable license. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| prop | Yes | Request article text extracts. | |
| action | Yes | Select the read-only query action. | |
| format | Yes | Return a JSON response. | |
| titles | Yes | One Chinese Wikipedia article title. Do not use the pipe character to combine titles. | |
| exchars | Yes | Requested extract length in characters, from 1 to 500. MediaWiki may return a few extra characters. | |
| exintro | Yes | Return the lead section only. | |
| redirects | Yes | Resolve Wikipedia title redirects. | |
| explaintext | Yes | Return plain text in the extract field. | |
| formatversion | Yes | Use JSON format version 2. |
wikimedia_get_zh_searchChinese Wikipedia Article SearchInspect
Find Chinese Wikipedia articles by keyword. Credit Wikipedia contributors and link to the original article when displaying excerpts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Search keywords. | |
| limit | Yes | Maximum number of search results. |
wikivoyage_get_guide_titleWikivoyage Travel GuideInspect
Retrieve an English Wikivoyage travel guide as HTML with revision and license metadata. Credit Wikivoyage contributors and link to the original guide and its license when reusing text. Check media licenses separately and sanitize HTML before rendering. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Wikivoyage page title or page key, such as Kyoto. Prefer the key returned by destination search and encode it as one URL path segment. |
wikivoyage_get_searchWikivoyage Destination SearchInspect
Search English Wikivoyage for destinations and travel guides. Use the returned page key to retrieve a guide. Credit Wikivoyage contributors and link to the source when reusing excerpts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Destination or travel topic keywords, such as Kyoto. | |
| limit | No | Maximum number of results to return. OpenAny accepts 1 to 20. Omit this parameter to use the upstream default. |
wikivoyage_get_zh_guide_titleChinese Wikivoyage Travel GuideInspect
Retrieve an Chinese Wikivoyage travel guide as HTML with revision and license metadata. Credit Wikivoyage contributors and link to the original guide and its license when reusing text. Check media licenses separately and sanitize HTML before rendering. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Wikivoyage page title or page key. Prefer the key returned by destination search and encode it as one URL path segment. |
wikivoyage_get_zh_searchChinese Wikivoyage Destination SearchInspect
Search Chinese Wikivoyage for destinations and travel guides. Use the returned page key to retrieve a guide. Credit Wikivoyage contributors and link to the source when reusing excerpts. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Destination or travel topic keywords. | |
| limit | No | Maximum number of results to return. OpenAny accepts 1 to 20. Omit this parameter to use the upstream default. |
youcom_post_v1_answerAnswerInspect
Generate a cited answer using a single web-search pass. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The search query used to retrieve relevant web results. | |
| country | No | A supported country code that determines the geographical focus of the web results. | |
| language | No | A supported BCP 47 language tag that determines the language of the web results. | |
| safesearch | No | Configures the safesearch filter for content moderation. This allows you to decide whether to return NSFW content or not. | |
| boost_domains | No | Domains to prefer in search ranking without excluding results from other domains. Supports up to 500 domains. Can be combined with `exclude_domains`, but not with `include_domains`. | |
| exclude_domains | No | Domains to exclude from web results. Supports up to 500 domains. Cannot be combined with `include_domains`. Can be combined with `boost_domains`. | |
| include_domains | No | Domains to exclusively include in web results. This is a strict allowlist, not a ranking boost. Supports up to 500 domains. Cannot be combined with `exclude_domains` or `boost_domains`. |
youcom_post_v1_searchWeb Search (Basic, no extraction)Inspect
Search web and news results with all page-extraction options disabled. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | Specifies the maximum number of search results to return per section (the sections are `web` and `news`. See the JSON response to visualize them). | |
| query | Yes | The search query used to retrieve relevant results from the web. You can also include [search operators](https://you.com/docs/guides/search/search-operators) to refine your search. | |
| offset | No | Indicates the `offset` for pagination. The `offset` is calculated in multiples of `count`. For example, if `count = 5` and `offset = 1`, results 5–10 will be returned. Range `0 ≤ offset ≤ 9`. | |
| country | No | The country code that determines the geographical focus of the web results. | |
| language | No | The language of the web results that will be returned (BCP 47 format). | |
| knowledge | No | Requests knowledge results alongside web and news search. | |
| safesearch | No | Configures the safesearch filter for content moderation. This allows you to decide whether to return NSFW content or not. | |
| boost_domains | No | A list of domains to boost in search ranking. Matching results from these domains receive a fixed relative ranking boost, but this is not a filter. If the boosted domains do not have matching results, results from other domains can still appear. Supports up to 500 domains. Can be combined with `exclude_domains`. Cannot be combined with `include_domains`. Passing both `boost_domains` and `include_domains` will return a `422` error. | |
| exclude_domains | No | A list of domains to exclude from search results. Results from these domains will be filtered out. Supports up to 5000 domains. Cannot be combined with `include_domains`; passing both will return a `422` error. | |
| include_domains | No | A list of domains to restrict search results to. Only results from these domains will be returned. Supports up to 500 domains. This is a strict allowlist, not a boost — results are limited exclusively to the specified domains. Cannot be combined with `exclude_domains`; passing both will return a `422` error. | |
| strict_operators | No | Enforce search operators such as quoted phrases and `site:` exactly. By default, when a query's operators match no pages, the search relaxes them and returns the closest matches. Has no effect with `extraction_mode: "highlights"`. |
yuandian_get_open_rh_case_detailsCase Detail APIInspect
Retrieves details for a case category. At least one of id or ah must be supplied, and type is optional. data is a list containing at most 10 items. Ordinary and authoritative cases have different fields, and their detail URLs point to separate ordinary-case and authoritative-case paths. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ah | No | Case number; used for lookup when `id` is omitted | |
| id | No | Case identifier | |
| type | No | Case category filter: `ptal` (ordinary cases) or `qwal` (authoritative cases); no category filter if omitted |
yuandian_get_open_rh_company_detailEnterprise Details by ID or Unified Social Credit Code APIInspect
Precisely retrieve aggregated details for a single enterprise using its enterprise ID or unified social credit code; provide at least one of id and tyshxydm. When both are supplied, id takes priority, and only the first match is used. Results include business registration, personnel, branches, changes and investments, intellectual property, litigation summaries, and risk information. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID (ES document `_id`, queried precisely using `idsQuery`) | |
| tyshxydm | No | Unified social credit code (corresponding field `company.creditNo`, queried using `termsQuery`) |
yuandian_get_open_rh_company_infoEnterprise Details by Name or Stock Short Name APIInspect
Search by an enterprise name, former name, or stock short name and return a list of candidate enterprise details. name is required. num defaults to 2; values greater than 50 or less than 0 are replaced with 10. Use this API to find candidate enterprises and their aggregated details from a name, rather than for a strict unique-enterprise-ID query. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| num | No | Requested upper limit on the number of ES search hits; **defaults to `2`** | |
| name | Yes | Search term such as an enterprise name or stock short name |
yuandian_get_open_rh_enterpriseabnormaloperationEnterprise Abnormal Operations List APIInspect
Retrieve abnormal operations records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseaggregationsummaryEnterprise Aggregated Overview APIInspect
Return an overview of statistics across multiple enterprise information modules using an enterprise ID or unified social credit code; provide at least one of id and tyshxydm. Results contain aggregated statistics and Top 20 summaries for the different information categories, rather than complete details for each module. For complete paginated details, call the corresponding list APIs for trademarks, patents, hearing notices, court announcements, administrative penalties, and other modules. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseannualreportEnterprise Annual Report Details APIInspect
Retrieve structured details of an enterprise annual report for a specified year using the enterprise ID or unified social credit code and the reporting year. Details include basic information, shareholder capital contributions, websites and online stores, assets, external investments, and external guarantees. Use the Enterprise Basic Information API to check which reporting years are available. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| year | Yes | Annual report year (corresponding to ES `reportYear`) | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisebaseinfoEnterprise Basic Information APIInspect
Retrieve flat enterprise details using an enterprise ID or unified social credit code, including basic information, shareholders, the top 10 shareholders, the top 10 holders of tradable shares, key personnel, and branches. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisebrandEnterprise Trademark List APIInspect
Retrieve trademark records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisechangeinfoEnterprise Registration Change List APIInspect
Retrieve registration change records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisecorporatetaxEnterprise Tax Arrears Announcement List APIInspect
Retrieve tax arrears announcements for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisecourtnoticeEnterprise Court Announcement List APIInspect
Retrieve court announcements for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisecourtsessionnoticeEnterprise Hearing Notice List APIInspect
Retrieve hearing notices for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseexecutedpersonEnterprise Judgment Debtor List APIInspect
Retrieve judgment debtor records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseexecutionsEnterprise Dishonest Judgment Debtor List APIInspect
Retrieve dishonest judgment debtor records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisefrozenequityEnterprise Equity Freeze List APIInspect
Retrieve equity freeze records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseguarantyEnterprise External Guarantee List APIInspect
Retrieve external guarantee records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseicpEnterprise Website Filing List APIInspect
Retrieve website filing records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseoutinvestEnterprise External Investment List APIInspect
Retrieve external investment records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisepatentEnterprise Patent List APIInspect
Retrieve patent records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisepledgeEnterprise Equity Pledge List APIInspect
Retrieve equity pledge records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisepunishmentEnterprise Administrative Penalty List APIInspect
Retrieve administrative penalty records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisesearchEnterprise Search APIInspect
Search for candidate enterprises by enterprise-name keywords to obtain their enterprise IDs and unified social credit codes first. name is required. top_k defaults to 10 and accepts values from 1 to 50; out-of-range values use the default. Results contain basic identifiers for candidate enterprises, rather than complete enterprise details. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Enterprise name | |
| top_k | No | Number of results; defaults to 10; range 1~50; out-of-range values use the default |
yuandian_get_open_rh_enterpriseseriousillegalEnterprise Serious Violation List APIInspect
Retrieve serious violation records for an enterprise using its enterprise ID or unified social credit code. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisesoftrightEnterprise Software Copyright List APIInspect
Retrieve software copyright records for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterpriseworksrightEnterprise Work Copyright List APIInspect
Retrieve copyright records for works for an enterprise using its enterprise ID or unified social credit code. Results are paginated, with 30 records per page by default. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisewritaggEnterprise Litigation Statistics APIInspect
Using an enterprise ID or unified social credit code, calculate distributions of the enterprise's litigation information across case categories, causes of action, document types, trial procedures, court levels, case closure methods, case closure years, regions, litigation roles, and opposing-party types. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID | |
| tyshxydm | No | Unified social credit code |
yuandian_get_open_rh_enterprisewritlistEnterprise Litigation Document List APIInspect
Retrieve a paginated list of litigation documents related to an enterprise using its enterprise ID or unified social credit code; provide at least one of id and tyshxydm. pageNo defaults to 1, with 30 records per page by default. The response is a pagination object whose list items are litigation document summaries rather than full texts. To retrieve a full text, use the document information to call a case or document details API. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Enterprise ID (primary table `legal_insight_qyfx_company`, document `_id`) | |
| pageNo | No | Page number; defaults to 1 | |
| tyshxydm | No | Unified social credit code |
yuandian_post_open_case_vector_searchCase Semantic Search APIInspect
Performs semantic similarity search in the case database using a natural-language query. By default, searches both ordinary and authoritative cases. wenshu_filter supports filters such as case category, cause of action, document type, court, region, closing date, and typical cases. Returns complete case content that has been organized for presentation, which is not equivalent to the verbatim full text of the original court document, together with similarity scores. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Question or query text to search for | |
| return_num | No | Number of cases to return (default 45; cannot exceed the total number retrieved) | |
| rewrite_flag | No | Whether to rewrite the query; defaults to `false` | |
| wenshu_filter | No | Case search filters; see the field descriptions for details |
yuandian_post_open_law_vector_searchLaws and Regulations Semantic Search APIInspect
Performs semantic search at the legal provision level using a natural-language query. Supports filters for validity status, first-level legal authority, and effective date range. Results are in extra.fatiao; each result primarily contains a legal provision and information about its parent regulation, rather than the full text of an entire regulation. To retrieve regulation details, call the regulation detail API with the regulation ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Question or query text to search for | |
| return_num | No | Number of laws and regulations to return (default 45; cannot exceed the total number retrieved) | |
| rewrite_flag | No | Whether to rewrite the query; defaults to `false` | |
| fatiao_filter | No | Filters for searching laws and regulations; see the field descriptions for details |
yuandian_post_open_law_vector_zq_searchSecurities Industry Laws and Regulations Semantic Search APIInspect
Performs semantic search at the legal provision level for the securities industry using a natural-language query. Supports filters for validity status, first-level legal authority, and effective date range. Results are in extra.fatiao; each result primarily contains a legal provision and information about its parent regulation, rather than the full text of an entire regulation. To retrieve regulation details, call the regulation detail API with the regulation ID. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Question or query text to search for | |
| return_num | No | Number of laws and regulations to return (default 45; cannot exceed the total number retrieved) | |
| rewrite_flag | No | Whether to rewrite the query; defaults to `false` | |
| fatiao_filter | No | Filters for searching laws and regulations; see the field descriptions for details |
yuandian_post_open_rh_fg_detailRegulation Detail APIInspect
Retrieves regulation details. The request body must not be empty, and at least one of id or fgmc must be supplied. refer_date can be used to locate the version effective on a specified date; if omitted, returns details related to the currently effective version. Returns basic regulation information, validity status, publication and effective dates, issuing departments, attachments, and regulation content. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ID of the detail target. | |
| fgmc | No | Regulation name (required when `id` is empty) | |
| refer_date | No | Reference date used to determine the laws and regulations effective at that time; if omitted, uses the currently effective version. Format: yyyy-MM-dd |
yuandian_post_open_rh_fg_searchRegulation Keyword Search APIInspect
Searches for a list of regulations. The request body must not be empty, but keyword may be omitted. Without keywords, results are primarily selected using filters such as regulation name, validity status, region, legal authority, publication date, and effective date. An item includes content only when keywords are supplied and a highlighted match is found; content is a snippet, not the full regulation text. Use the regulation detail API for the full text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dy | No | Region filter; split on spaces and match any term. Allowed literal values: 中央、北京、天津、河北、山西、内蒙古、辽宁、吉林、黑龙江、上海、江苏、浙江、安徽、福建、江西、山东、河南、湖北、湖南、广东、广西、海南、重庆、四川、贵州、云南、西藏、陕西、甘肃、青海、宁夏、新疆 | |
| sxx | No | Validity status filter; split on spaces and match any term. Allowed literal values: 现行有效、失效、已被修改、部分失效、尚未生效 | |
| fbbm | No | Issuing department filter; split on spaces and match any substring | |
| fgmc | No | Regulation name filter; split on spaces and require every term to match the regulation title | |
| top_k | No | Maximum number of results; default 10, maximum 50 | |
| xljb_1 | No | Legal authority filter; split on spaces and match any term. Allowed literal values: 宪法、法律、司法解释、行政法规、监察法规、部门规章、党内法规、军事法规规章、立法机关工作文件、行政机关工作文件、行业/团体规范、地方性法规、自治条例和单行条例、地方司法文件、地方政府规章、地方规范性文件、地方律协规定; | |
| keyword | No | Keywords in regulation text; split on spaces and join with AND/OR according to `search_mode` to form a queryString | |
| fbrq_end | No | Publication date range end (inclusive), in yyyy-MM-dd format | |
| ssrq_end | No | Effective date range end (inclusive), in yyyy-MM-dd format | |
| fbrq_start | No | Publication date range start (inclusive), in yyyy-MM-dd format | |
| ssrq_start | No | Effective date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Keyword combination mode; defaults to `AND` and is converted to uppercase (for example, `AND`/`OR`) |
yuandian_post_open_rh_fg_zq_searchSecurities Industry Regulation Keyword Search APIInspect
Searches for a list of securities industry regulations. The request body must not be empty, but keyword may be omitted. Without keywords, results are primarily selected using filters such as regulation name, validity status, region, legal authority, publication date, and effective date. An item includes content only when keywords are supplied and a highlighted match is found; content is a snippet, not the full regulation text. Use the regulation detail API for the full text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dy | No | Region filter; split on spaces and match any term. Allowed literal values: 中央、北京、天津、河北、山西、内蒙古、辽宁、吉林、黑龙江、上海、江苏、浙江、安徽、福建、江西、山东、河南、湖北、湖南、广东、广西、海南、重庆、四川、贵州、云南、西藏、陕西、甘肃、青海、宁夏、新疆 | |
| sxx | No | Validity status filter; split on spaces and match any term. Allowed literal values: 现行有效、失效、已被修改、部分失效、尚未生效 | |
| fbbm | No | Issuing department filter; split on spaces and match any substring | |
| fgmc | No | Regulation name filter; split on spaces and require every term to match the regulation title | |
| top_k | No | Maximum number of results; default 10, maximum 50 | |
| xljb_1 | No | Legal authority filter; split on spaces and match any term. Allowed literal values: 宪法、法律、司法解释、行政法规、监察法规、部门规章、党内法规、军事法规规章、立法机关工作文件、行政机关工作文件、行业/团体规范、地方性法规、自治条例和单行条例、地方司法文件、地方政府规章、地方规范性文件、地方律协规定; | |
| keyword | No | Keywords in regulation text; split on spaces and join with AND/OR according to `search_mode` to form a queryString | |
| fbrq_end | No | Publication date range end (inclusive), in yyyy-MM-dd format | |
| ssrq_end | No | Effective date range end (inclusive), in yyyy-MM-dd format | |
| fbrq_start | No | Publication date range start (inclusive), in yyyy-MM-dd format | |
| ssrq_start | No | Effective date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Keyword combination mode; defaults to `AND` and is converted to uppercase (for example, `AND`/`OR`) |
yuandian_post_open_rh_ft_detailLegal Provision Detail APIInspect
Retrieves details of a single legal provision. The request body must not be empty. id takes precedence when locating the provision; alternatively, use fgmc with ftnum to locate a specific provision in a named regulation. refer_date can be supplied to locate the version applicable on a specified date. Returns provision text, provision number, parent regulation ID and name, validity status, publication and effective dates, and related information. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ID of the detail target. | |
| fgmc | No | Regulation name (required when `id` is empty) | |
| ftnum | No | Provision number/name (required when `id` is empty) | |
| refer_date | No | Reference date used to determine the laws and regulations effective at that time; if omitted, uses the currently effective version. Format: yyyy-MM-dd |
yuandian_post_open_rh_ft_searchLegal Provision Keyword Search APIInspect
Searches legal provision text using the required keyword parameter. Supports filters for parent regulation name, legal authority, validity status, region, publication date, and effective date. Returns a list of individual legal provisions, each with its text, provision number, parent regulation ID and name, and regulation metadata; it does not return the full text of entire regulations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dy | No | Region filter; split on spaces and match any term. Allowed literal values: 中央、北京、天津、河北、山西、内蒙古、辽宁、吉林、黑龙江、上海、江苏、浙江、安徽、福建、江西、山东、河南、湖北、湖南、广东、广西、海南、重庆、四川、贵州、云南、西藏、陕西、甘肃、青海、宁夏、新疆 | |
| sxx | No | Validity status filter; split on spaces and match any term. Allowed literal values: 现行有效、失效、已被修改、部分失效、尚未生效 | |
| fbbm | No | Issuing department filter; split on spaces and match any substring | |
| fgmc | No | Regulation name filter; split on spaces and require every term to match the regulation title | |
| top_k | No | Maximum number of results; default 10, maximum 50 | |
| xljb_1 | No | Legal authority filter; split on spaces and match any term. Allowed literal values: 宪法、法律、司法解释、行政法规、监察法规、部门规章、党内法规、军事法规规章、立法机关工作文件、行政机关工作文件、行业/团体规范、地方性法规、自治条例和单行条例、地方司法文件、地方政府规章、地方规范性文件、地方律协规定; | |
| keyword | Yes | Keywords in provision text; split on spaces and join with AND/OR according to `search_mode` to form a queryString | |
| fbrq_end | No | Publication date range end (inclusive), in yyyy-MM-dd format | |
| ssrq_end | No | Effective date range end (inclusive), in yyyy-MM-dd format | |
| fbrq_start | No | Publication date range start (inclusive), in yyyy-MM-dd format | |
| ssrq_start | No | Effective date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Keyword combination mode; defaults to `AND` and is converted to uppercase (for example, `AND`/`OR`) |
yuandian_post_open_rh_ft_zq_searchSecurities Industry Legal Provision Keyword Search APIInspect
Searches securities-related legal provision text using the required keyword parameter. Supports filters for parent regulation name, legal authority, validity status, region, publication date, and effective date. Returns a list of individual legal provisions, each with its text, provision number, parent regulation ID and name, and regulation metadata; it does not return the full text of entire regulations. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| dy | No | Region filter; split on spaces and match any term. Allowed literal values: 中央、北京、天津、河北、山西、内蒙古、辽宁、吉林、黑龙江、上海、江苏、浙江、安徽、福建、江西、山东、河南、湖北、湖南、广东、广西、海南、重庆、四川、贵州、云南、西藏、陕西、甘肃、青海、宁夏、新疆 | |
| sxx | No | Validity status filter; split on spaces and match any term. Allowed literal values: 现行有效、失效、已被修改、部分失效、尚未生效 | |
| fbbm | No | Issuing department filter; split on spaces and match any substring | |
| fgmc | No | Regulation name filter; split on spaces and require every term to match the regulation title | |
| top_k | No | Maximum number of results; default 10, maximum 50 | |
| xljb_1 | No | Legal authority filter; split on spaces and match any term. Allowed literal values: 宪法、法律、司法解释、行政法规、监察法规、部门规章、党内法规、军事法规规章、立法机关工作文件、行政机关工作文件、行业/团体规范、地方性法规、自治条例和单行条例、地方司法文件、地方政府规章、地方规范性文件、地方律协规定; | |
| keyword | Yes | Keywords in provision text; split on spaces and join with AND/OR according to `search_mode` to form a queryString | |
| fbrq_end | No | Publication date range end (inclusive), in yyyy-MM-dd format | |
| ssrq_end | No | Effective date range end (inclusive), in yyyy-MM-dd format | |
| fbrq_start | No | Publication date range start (inclusive), in yyyy-MM-dd format | |
| ssrq_start | No | Effective date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Keyword combination mode; defaults to `AND` and is converted to uppercase (for example, `AND`/`OR`) |
yuandian_post_open_rh_ptal_searchOrdinary Case Keyword Search APIInspect
Searches for a list of ordinary adjudicated cases. Supports filters for case number, title, companies involved in litigation, cause of action, court, region, document type, case category, judgment/closing date, full-text keywords, reasoning keywords, and cited legal provisions. The request body must not be empty. Returns the total number of matches and a case list. content is a highlighted matching snippet or an abstract/reasoning excerpt, rather than the complete body text. Call the case detail API when full text is required. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ah | No | Case number | |
| ay | No | Array of causes of action; multiple values are combined with OR | |
| qw | No | Full-text keywords (split on spaces and join with AND/OR according to `search_mode` to form a queryString) | |
| ajlb | No | Case category. Allowed literal values: 刑事案件、民事案件、行政案件、执行案件、管辖案件、国家赔偿与司法救助案件、强制清算与破产案件、国际司法协助案件、非诉保全审查案件、其他案件" | |
| fxgc | No | Reasoning keywords (split on spaces and join with AND/OR according to `search_mode` to form a queryString) | |
| jbdw | No | Array of handling courts/organizations; multiple values are combined with OR | |
| ssqy | No | Company involved in litigation filter; a single value matched as a substring | |
| wszl | No | Array of document types. Allowed literal values: 判决书 (judgment), 裁定书 (ruling), 调解书 (mediation statement), 决定书 (decision); multiple values are combined with OR | |
| yyft | No | Array of cited legal provisions (for example, 中华人民共和国刑法第二条). Each array element may contain only one provision, and its article number must use a Chinese format such as 第二条 | |
| title | No | Title search; split on spaces and require every term to match the title | |
| top_k | No | Maximum number of results: default 10, maximum 50; values less than or equal to 0 use the default of 10 | |
| ja_end | No | Closing/judgment date range end (inclusive), in yyyy-MM-dd format | |
| lawyer | No | Lawyer name filter; a single value matched exactly. Combine with `lawfirm` to filter for a lawyer at a specified law firm | |
| xzqh_p | No | Array of province-level administrative divisions. Allowed literal values: 北京、天津、河北、山西、内蒙古、辽宁、吉林、黑龙江、上海、江苏、浙江、安徽、福建、江西、山东、河南、湖北、湖南、广东、广西、海南、重庆、四川、贵州、云南、西藏、陕西、甘肃、青海、宁夏、新疆、最高、新疆生产建设兵团; multiple values are combined with OR | |
| lawfirm | No | Law firm filter; a single value matched as a substring. Combine with `lawyer` to filter for a lawyer at a specified law firm | |
| ja_start | No | Closing/judgment date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Keyword combination mode: `and` or `or`; defaults to `and` when empty; invalid values result in failure | |
| ft_search_mode | No | Combination mode for `yyft`: `and` or `or`; defaults to `and` when empty; invalid values result in failure |
yuandian_post_open_rh_qwal_searchAuthoritative Case Keyword Search APIInspect
Searches for a list of authoritative, typical, and reference cases. Supports filters for case number, title, cause of action, court, region, document type, case category, judgment date, and full-text keywords. The request body must not be empty. Returns the total number of matches and a case list. content preferentially contains the key judicial reasoning, an abstract, or a case explanation, falling back to body text only when these are absent. It is not guaranteed to be the complete court document; call the case detail API when full text is required. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| ah | No | Case number | |
| ay | No | Array of causes of action; multiple values are combined with OR | |
| qw | No | Full-text keywords (split on spaces and join with AND/OR according to `search_mode` to form a queryString) | |
| ajlb | No | Case category. Allowed literal values: 刑事案件、民事案件、行政案件、执行案件、管辖案件、国家赔偿与司法救助案件、强制清算与破产案件、国际司法协助案件、非诉保全审查案件、其他案件" | |
| jbdw | No | Array of handling courts; multiple values are combined with OR | |
| wszl | No | Array of document types. Allowed literal values: 判决书 (judgment), 裁定书 (ruling), 调解书 (mediation statement), 决定书 (decision); multiple values are combined with OR | |
| title | No | Title search; split on spaces and require every term to match the title | |
| top_k | No | Maximum number of results: default 10, maximum 50; values less than or equal to 0 use the default of 10 | |
| ja_end | No | Judgment date range end (inclusive), in yyyy-MM-dd format | |
| source | No | Array of case sources. Allowed literal values: 典型案例、参考案例、公报案例、解纷案例、参阅案例、刑事参考案例、指导性案例、检指导案例; multiple values are combined with OR | |
| xzqh_p | No | Array of province-level administrative divisions. Allowed literal values: 北京、天津、河北、山西、内蒙古、辽宁、吉林、黑龙江、上海、江苏、浙江、安徽、福建、江西、山东、河南、湖北、湖南、广东、广西、海南、重庆、四川、贵州、云南、西藏、陕西、甘肃、青海、宁夏、新疆、最高、新疆生产建设兵团; multiple values are combined with OR | |
| ja_start | No | Judgment date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Keyword combination mode: `and` or `or`; defaults to `and` when empty; invalid values result in failure |
yuandian_post_open_rh_ssgsgg_searchListed Company Announcement Keyword Search APIInspect
Searches for a list of listed company announcements. Supports filters for title, full company name, stock short name, exchange, region, China Association for Public Companies classification, announcement publication date, and full-text keywords. The request body must not be empty. Returns matching announcements, with content containing matching snippets. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| jc | No | Stock short name; exact matching | |
| area | No | Region; exact matching. Allowed literal values: 浙江、北京、广东、江苏、上海、山东、四川、安徽、福建、湖北、湖南、河南、重庆、辽宁、江西、河北、新疆、陕西、海南、天津、甘肃、云南、吉林、黑龙江、广西、山西、贵州、西藏、宁夏、内蒙古、青海、境外、香港 | |
| name | No | Full company name filter; fuzzy substring matching | |
| title | No | Announcement title; split on spaces and require all terms to match the title | |
| top_k | No | Number of results; default **50**, maximum **50**; sorted by `_score` | |
| market | No | Exchange; exact matching. Allowed literal values: 深证A股 (Shenzhen A shares), 上证A股 (Shanghai A shares), 北证A股 (Beijing A shares) | |
| content | No | Announcement full-text search terms; split on spaces and combine the terms according to `search_mode` | |
| fbrq_end | No | Announcement publication date range end (inclusive), in yyyy-MM-dd format | |
| zsx_type | No | China Association for Public Companies classification filter; fuzzy substring matching | |
| fbrq_start | No | Announcement publication date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Full-text keyword combination mode: `AND` / `OR`, default `AND`; applies only to `content` |
yuandian_post_open_rh_zqcfws_searchRegulatory Enforcement Case Keyword Search APIInspect
Searches for a list of regulatory enforcement cases. Supports filters for title, full company name, sanctioned entity name, sanctioning authority, regulatory action type, sanction date, and full-text keywords. The request body must not be empty. Returns the total number of matches and a case list, with content containing the body text. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
| Name | Required | Description | Default |
|---|---|---|---|
| cfjg | No | Sanctioning authority filter; fuzzy substring matching | |
| cfzt | No | Sanctioned entity name filter; fuzzy substring matching | |
| jglb | No | Regulatory action type; exact matching. Allowed literal values: 监管函 (regulatory letter), 出具警示函 (issuance of a warning letter), 通报批评 (circulated criticism), 公开谴责 (public censure), 约见谈话 (summons for a meeting) | |
| title | No | Title; split on spaces and require all terms to match the title | |
| top_k | No | Number of results; default **50**, maximum **50**; sorted by `_score` | |
| company | No | Full company name filter; fuzzy substring matching | |
| content | No | Full text; split on spaces and combine the terms according to `search_mode` | |
| cfsj_end | No | Sanction date range end (inclusive), in yyyy-MM-dd format | |
| cfsj_start | No | Sanction date range start (inclusive), in yyyy-MM-dd format | |
| search_mode | No | Full-text keyword combination mode: `AND` / `OR`, default `AND`; |
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
3256 tool updates
- First observed
accurlex_post_law_search_deep_accurlex_law_search - First observed
accurlex_post_law_search_expert_accurlex_law_search - First observed
accurlex_post_qa_deep_accurlex_legal_qa - First observed
aihot_get_api_v1_agent_codex_resets - First observed
aihot_get_api_v1_agent_daily_date - First observed
aihot_get_api_v1_agent_hot - First observed
aihot_get_api_v1_agent_latest - First observed
aihot_get_api_v1_agent_latest_daily - First observed
aihot_get_api_v1_agent_monthly - First observed
aihot_get_api_v1_agent_monthly_by_month_month - First observed
aihot_get_api_v1_agent_search - First observed
aihot_get_api_v1_agent_story_publicid - First observed
aihot_get_api_v1_agent_weekly - First observed
aihot_get_api_v1_agent_weekly_by_week_week - First observed
aihot_get_api_v1_codex_resets - First observed
aihot_get_api_v1_codex_resets_recent - First observed
aihot_get_api_v1_dailies - First observed
aihot_get_api_v1_daily_by_date_date - First observed
aihot_get_api_v1_hot_topics - First observed
aihot_get_api_v1_items - First observed
aihot_get_api_v1_latest_daily - First observed
aihot_get_api_v1_latest_monthly - First observed
aihot_get_api_v1_latest_weekly - First observed
aihot_get_api_v1_monthlies - First observed
aihot_get_api_v1_monthly_by_month_month - First observed
aihot_get_api_v1_selected_changes - First observed
aihot_get_api_v1_story_by_public_id_publicid - First observed
aihot_get_api_v1_weeklies - First observed
aihot_get_api_v1_weekly_by_week_week - First observed
alchemy_get_nft_v3_getcontractmetadata - First observed
alchemy_get_nft_v3_getcontractsforowner - First observed
alchemy_get_nft_v3_getfloorprice - First observed
alchemy_get_nft_v3_getnftmetadata - First observed
alchemy_get_nft_v3_getnftsforcontract - First observed
alchemy_get_nft_v3_getnftsforowner - First observed
alchemy_get_nft_v3_getownersforcontract - First observed
alchemy_get_nft_v3_getownersfornft - First observed
alchemy_post_nft_v3_getcontractmetadatabatch - First observed
alchemy_post_nft_v3_getnftmetadatabatch - First observed
alchemy_post_prices_v1_tokens_by_address - First observed
alchemy_post_prices_v1_tokens_historical - First observed
anyapi_post_v1_run_ahrefs_backlinks - First observed
anyapi_post_v1_run_airbnb_search - First observed
anyapi_post_v1_run_alibaba_search - First observed
anyapi_post_v1_run_amazon_bestsellers - First observed
anyapi_post_v1_run_amazon_product - First observed
anyapi_post_v1_run_amazon_reviews - First observed
anyapi_post_v1_run_amazon_search - First observed
anyapi_post_v1_run_apollo_organization - First observed
anyapi_post_v1_run_apollo_organization_enrich - First observed
anyapi_post_v1_run_apollo_organization_jobs - First observed
anyapi_post_v1_run_apollo_organization_news - First observed
anyapi_post_v1_run_apollo_organizations_bulk_enrich - First observed
anyapi_post_v1_run_apollo_organizations_search - First observed
anyapi_post_v1_run_apollo_people_search - First observed
anyapi_post_v1_run_apollo_person_enrich - First observed
anyapi_post_v1_run_appstore_reviews - First observed
anyapi_post_v1_run_bluesky_post - First observed
anyapi_post_v1_run_bluesky_profile - First observed
anyapi_post_v1_run_bluesky_user_posts - First observed
anyapi_post_v1_run_booking_search - First observed
anyapi_post_v1_run_capterra_reviews - First observed
anyapi_post_v1_run_chatgpt_search - First observed
anyapi_post_v1_run_coinmarketcap_listings - First observed
anyapi_post_v1_run_company_enrichment_lusha - First observed
anyapi_post_v1_run_company_enrichment_peopledatalabs - First observed
anyapi_post_v1_run_company_enrichment_prospeo - First observed
anyapi_post_v1_run_company_identify_crustdata_v3 - First observed
anyapi_post_v1_run_company_search_ai_ark - First observed
anyapi_post_v1_run_company_search_fullenrich - First observed
anyapi_post_v1_run_company_search_peopledatalabs - First observed
anyapi_post_v1_run_company_search_prospeo - First observed
anyapi_post_v1_run_company_search_quickenrich - First observed
anyapi_post_v1_run_company_search_theirstack - First observed
anyapi_post_v1_run_congress_trades - First observed
anyapi_post_v1_run_contact_enrichment_crustdata_v3 - First observed
anyapi_post_v1_run_douyin_profile - First observed
anyapi_post_v1_run_douyin_search_videos - First observed
anyapi_post_v1_run_douyin_user_posts - First observed
anyapi_post_v1_run_douyin_video - First observed
anyapi_post_v1_run_douyin_video_comments - First observed
anyapi_post_v1_run_ebay_product - First observed
anyapi_post_v1_run_ebay_product_full - First observed
anyapi_post_v1_run_ebay_search - First observed
anyapi_post_v1_run_ebay_sold_listings - First observed
anyapi_post_v1_run_ebay_sold_listings_thin - First observed
anyapi_post_v1_run_email_find - First observed
anyapi_post_v1_run_email_finding_dropleads - First observed
anyapi_post_v1_run_email_finding_hunter_count - First observed
anyapi_post_v1_run_email_finding_hunter_domain - First observed
anyapi_post_v1_run_email_finding_quickenrich - First observed
anyapi_post_v1_run_email_finding_zerobounce - First observed
anyapi_post_v1_run_email_finding_zerobounce_domain - First observed
anyapi_post_v1_run_email_verification_allegrow - First observed
anyapi_post_v1_run_email_verification_icypeas - First observed
anyapi_post_v1_run_email_verification_zerobounce - First observed
anyapi_post_v1_run_email_verification_zerobounce_activity - First observed
anyapi_post_v1_run_email_verify - First observed
anyapi_post_v1_run_facebook_ad_details - First observed
anyapi_post_v1_run_facebook_ad_details_full - First observed
anyapi_post_v1_run_facebook_ad_transcript - First observed
anyapi_post_v1_run_facebook_ads_search - First observed
anyapi_post_v1_run_facebook_comment_replies - First observed
anyapi_post_v1_run_facebook_event_details - First observed
anyapi_post_v1_run_facebook_events - First observed
anyapi_post_v1_run_facebook_events_search - First observed
anyapi_post_v1_run_facebook_followers - First observed
anyapi_post_v1_run_facebook_marketplace - First observed
anyapi_post_v1_run_facebook_marketplace_location_search - First observed
anyapi_post_v1_run_facebook_page_contact - First observed
anyapi_post_v1_run_facebook_page_lookup - First observed
anyapi_post_v1_run_facebook_photos - First observed
anyapi_post_v1_run_facebook_post - First observed
anyapi_post_v1_run_facebook_post_transcript - First observed
anyapi_post_v1_run_facebook_profile_events - First observed
anyapi_post_v1_run_facebook_search_companies - First observed
anyapi_post_v1_run_facebook_search_pages - First observed
anyapi_post_v1_run_facebook_search_posts - First observed
anyapi_post_v1_run_fiverr_search - First observed
anyapi_post_v1_run_gemini_search - First observed
anyapi_post_v1_run_github_repository - First observed
anyapi_post_v1_run_github_trending_developers - First observed
anyapi_post_v1_run_github_trending_repositories - First observed
anyapi_post_v1_run_github_user - First observed
anyapi_post_v1_run_github_user_activity - First observed
anyapi_post_v1_run_github_user_contributions - First observed
anyapi_post_v1_run_github_user_followers - First observed
anyapi_post_v1_run_github_user_following - First observed
anyapi_post_v1_run_github_user_pull_requests - First observed
anyapi_post_v1_run_github_user_repositories - First observed
anyapi_post_v1_run_google_ads_ad_details - First observed
anyapi_post_v1_run_google_ads_advertiser_search - First observed
anyapi_post_v1_run_google_ads_company_ads - First observed
anyapi_post_v1_run_google_ads_search - First observed
anyapi_post_v1_run_google_ai_mode - First observed
anyapi_post_v1_run_google_ai_overview - First observed
anyapi_post_v1_run_google_autocomplete - First observed
anyapi_post_v1_run_google_images - First observed
anyapi_post_v1_run_google_lens - First observed
anyapi_post_v1_run_google_news - First observed
anyapi_post_v1_run_google_patents - First observed
anyapi_post_v1_run_google_scholar - First observed
anyapi_post_v1_run_google_search - First observed
anyapi_post_v1_run_google_search_100 - First observed
anyapi_post_v1_run_google_shopping_search - First observed
anyapi_post_v1_run_google_videos - First observed
anyapi_post_v1_run_hackernews_profile - First observed
anyapi_post_v1_run_hackernews_search - First observed
anyapi_post_v1_run_hackernews_story - First observed
anyapi_post_v1_run_hackernews_story_comments - First observed
anyapi_post_v1_run_indeed_jobs - First observed
anyapi_post_v1_run_instagram_audio_reels - First observed
anyapi_post_v1_run_instagram_basic_profile - First observed
anyapi_post_v1_run_instagram_comment_replies - First observed
anyapi_post_v1_run_instagram_embed - First observed
anyapi_post_v1_run_instagram_followers - First observed
anyapi_post_v1_run_instagram_following - First observed
anyapi_post_v1_run_instagram_hashtag_analytics - First observed
anyapi_post_v1_run_instagram_hashtag_recent_posts - First observed
anyapi_post_v1_run_instagram_hashtag_top_posts - First observed
anyapi_post_v1_run_instagram_highlight_detail - First observed
anyapi_post_v1_run_instagram_location_posts - First observed
anyapi_post_v1_run_instagram_media_transcript - First observed
anyapi_post_v1_run_instagram_post - First observed
anyapi_post_v1_run_instagram_post_likers - First observed
anyapi_post_v1_run_instagram_profile_contact - First observed
anyapi_post_v1_run_instagram_reels_search - First observed
anyapi_post_v1_run_instagram_search - First observed
anyapi_post_v1_run_instagram_search_followers - First observed
anyapi_post_v1_run_instagram_search_following - First observed
anyapi_post_v1_run_instagram_search_locations - First observed
anyapi_post_v1_run_instagram_search_profiles - First observed
anyapi_post_v1_run_instagram_search_profiles_contact - First observed
anyapi_post_v1_run_instagram_similar_profiles - First observed
anyapi_post_v1_run_instagram_stories_full - First observed
anyapi_post_v1_run_instagram_stories_thin - First observed
anyapi_post_v1_run_instagram_tagged_posts - First observed
anyapi_post_v1_run_instagram_trending_reels - First observed
anyapi_post_v1_run_instagram_user_highlights - First observed
anyapi_post_v1_run_instagram_user_posts - First observed
anyapi_post_v1_run_instagram_user_reposts - First observed
anyapi_post_v1_run_instagram_web_reels_search - First observed
anyapi_post_v1_run_job_search_theirstack - First observed
anyapi_post_v1_run_linkedin_ad - First observed
anyapi_post_v1_run_linkedin_ads - First observed
anyapi_post_v1_run_linkedin_ads_search - First observed
anyapi_post_v1_run_linkedin_article - First observed
anyapi_post_v1_run_linkedin_company_employees - First observed
anyapi_post_v1_run_linkedin_company_posts_thin - First observed
anyapi_post_v1_run_linkedin_company_thin - First observed
anyapi_post_v1_run_linkedin_email - First observed
anyapi_post_v1_run_linkedin_job - First observed
anyapi_post_v1_run_linkedin_jobs - First observed
anyapi_post_v1_run_linkedin_jobs_thin - First observed
anyapi_post_v1_run_linkedin_post - First observed
anyapi_post_v1_run_linkedin_post_comments - First observed
anyapi_post_v1_run_linkedin_post_reactions - First observed
anyapi_post_v1_run_linkedin_post_transcript - First observed
anyapi_post_v1_run_linkedin_profile_comments - First observed
anyapi_post_v1_run_linkedin_profile_posts_full - First observed
anyapi_post_v1_run_linkedin_profile_posts_thin - First observed
anyapi_post_v1_run_linkedin_profile_reactions - First observed
anyapi_post_v1_run_linkedin_profile_thin - First observed
anyapi_post_v1_run_linkedin_search_companies - First observed
anyapi_post_v1_run_linkedin_search_posts_full - First observed
anyapi_post_v1_run_linkedin_search_profiles - First observed
anyapi_post_v1_run_linkedin_search_profiles_email - First observed
anyapi_post_v1_run_linkedin_search_profiles_thin - First observed
anyapi_post_v1_run_maps_contacts - First observed
anyapi_post_v1_run_maps_place - First observed
anyapi_post_v1_run_maps_reviews - First observed
anyapi_post_v1_run_maps_search - First observed
anyapi_post_v1_run_maps_search_nearby - First observed
anyapi_post_v1_run_mobile_phone_ai_ark - First observed
anyapi_post_v1_run_mobile_phone_leadmagic - First observed
anyapi_post_v1_run_naver_blog_search - First observed
anyapi_post_v1_run_nextdoor_business - First observed
anyapi_post_v1_run_nextdoor_search - First observed
anyapi_post_v1_run_people_search_ai_ark - First observed
anyapi_post_v1_run_people_search_crustdata_v3 - First observed
anyapi_post_v1_run_people_search_fullenrich - First observed
anyapi_post_v1_run_people_search_lusha - First observed
anyapi_post_v1_run_people_search_peopledatalabs - First observed
anyapi_post_v1_run_people_search_prospeo - First observed
anyapi_post_v1_run_people_search_quickenrich - First observed
anyapi_post_v1_run_people_search_quickenrich_company - First observed
anyapi_post_v1_run_perplexity_search - First observed
anyapi_post_v1_run_person_enrichment_bettercontact - First observed
anyapi_post_v1_run_person_enrichment_crustdata_v3 - First observed
anyapi_post_v1_run_person_enrichment_fullenrich_reverse_email - First observed
anyapi_post_v1_run_person_enrichment_lusha - First observed
anyapi_post_v1_run_person_enrichment_peopledatalabs - First observed
anyapi_post_v1_run_person_enrichment_prospeo - First observed
anyapi_post_v1_run_person_enrichment_quickenrich - First observed
anyapi_post_v1_run_pinterest_search - First observed
anyapi_post_v1_run_playstore_reviews - First observed
anyapi_post_v1_run_property_records_enformion - First observed
anyapi_post_v1_run_realtor_search - First observed
anyapi_post_v1_run_reddit_avatar - First observed
anyapi_post_v1_run_reddit_post - First observed
anyapi_post_v1_run_reddit_post_transcript - First observed
anyapi_post_v1_run_reddit_profile - First observed
anyapi_post_v1_run_reddit_search - First observed
anyapi_post_v1_run_reddit_subreddit_details - First observed
anyapi_post_v1_run_reddit_subreddit_posts - First observed
anyapi_post_v1_run_reddit_subreddit_search - First observed
anyapi_post_v1_run_reddit_trending_posts - First observed
anyapi_post_v1_run_reddit_user_comments - First observed
anyapi_post_v1_run_reddit_user_posts - First observed
anyapi_post_v1_run_redfin_property - First observed
anyapi_post_v1_run_redfin_search - First observed
anyapi_post_v1_run_rednote_note - First observed
anyapi_post_v1_run_rednote_note_comments - First observed
anyapi_post_v1_run_rednote_profile - First observed
anyapi_post_v1_run_rednote_search - First observed
anyapi_post_v1_run_rednote_search_users - First observed
anyapi_post_v1_run_rednote_user_notes - First observed
anyapi_post_v1_run_seo_backlinks_summary - First observed
anyapi_post_v1_run_seo_competitors_domain - First observed
anyapi_post_v1_run_seo_domain_intersection - First observed
anyapi_post_v1_run_seo_domain_rank_overview - First observed
anyapi_post_v1_run_seo_domain_technologies - First observed
anyapi_post_v1_run_seo_domains_by_technology - First observed
anyapi_post_v1_run_seo_keyword_difficulty - First observed
anyapi_post_v1_run_seo_keyword_ideas - First observed
anyapi_post_v1_run_seo_keyword_overview - First observed
anyapi_post_v1_run_seo_keyword_suggestions - First observed
anyapi_post_v1_run_seo_llm_mentions - First observed
anyapi_post_v1_run_seo_llm_top_brands - First observed
anyapi_post_v1_run_seo_llm_top_domains - First observed
anyapi_post_v1_run_seo_llm_top_pages - First observed
anyapi_post_v1_run_seo_local_pack - First observed
anyapi_post_v1_run_seo_ranked_keywords - First observed
anyapi_post_v1_run_seo_related_keywords - First observed
anyapi_post_v1_run_seo_search_intent - First observed
anyapi_post_v1_run_seo_search_volume - First observed
anyapi_post_v1_run_snapchat_profile - First observed
anyapi_post_v1_run_social_finder - First observed
anyapi_post_v1_run_spotify_album - First observed
anyapi_post_v1_run_spotify_artist - First observed
anyapi_post_v1_run_spotify_podcast - First observed
anyapi_post_v1_run_spotify_podcast_episodes - First observed
anyapi_post_v1_run_spotify_search - First observed
anyapi_post_v1_run_spotify_track - First observed
anyapi_post_v1_run_substack_posts - First observed
anyapi_post_v1_run_technographics_theirstack - First observed
anyapi_post_v1_run_threads_post - First observed
anyapi_post_v1_run_threads_profile - First observed
anyapi_post_v1_run_threads_search - First observed
anyapi_post_v1_run_threads_search_users - First observed
anyapi_post_v1_run_threads_user_posts - First observed
anyapi_post_v1_run_tiktok_ad_library_ad - First observed
anyapi_post_v1_run_tiktok_ad_library_search - First observed
anyapi_post_v1_run_tiktok_ad_transparency_search - First observed
anyapi_post_v1_run_tiktok_audience_demographics - First observed
anyapi_post_v1_run_tiktok_comment_replies - First observed
anyapi_post_v1_run_tiktok_followers - First observed
anyapi_post_v1_run_tiktok_following - First observed
anyapi_post_v1_run_tiktok_hashtag_videos - First observed
anyapi_post_v1_run_tiktok_live - First observed
anyapi_post_v1_run_tiktok_photos - First observed
anyapi_post_v1_run_tiktok_playlist_videos - First observed
anyapi_post_v1_run_tiktok_profile - First observed
anyapi_post_v1_run_tiktok_profile_contact - First observed
anyapi_post_v1_run_tiktok_profile_playlists - First observed
anyapi_post_v1_run_tiktok_profile_region - First observed
anyapi_post_v1_run_tiktok_profile_reposts - First observed
anyapi_post_v1_run_tiktok_search_hashtag - First observed
anyapi_post_v1_run_tiktok_search_photos - First observed
anyapi_post_v1_run_tiktok_search_suggestions - First observed
anyapi_post_v1_run_tiktok_search_top - First observed
anyapi_post_v1_run_tiktok_search_users - First observed
anyapi_post_v1_run_tiktok_shop_categories - First observed
anyapi_post_v1_run_tiktok_shop_creator - First observed
anyapi_post_v1_run_tiktok_shop_product - First observed
anyapi_post_v1_run_tiktok_shop_product_reviews - First observed
anyapi_post_v1_run_tiktok_shop_search - First observed
anyapi_post_v1_run_tiktok_shop_search_suggestions - First observed
anyapi_post_v1_run_tiktok_shop_shop_products - First observed
anyapi_post_v1_run_tiktok_shop_user_showcase - First observed
anyapi_post_v1_run_tiktok_song - First observed
anyapi_post_v1_run_tiktok_song_videos - First observed
anyapi_post_v1_run_tiktok_top_ads_search - First observed
anyapi_post_v1_run_tiktok_trending_feed - First observed
anyapi_post_v1_run_tiktok_trending_hashtags - First observed
anyapi_post_v1_run_tiktok_video_download - First observed
anyapi_post_v1_run_tiktok_video_transcript - First observed
anyapi_post_v1_run_tripadvisor_reviews - First observed
anyapi_post_v1_run_tripadvisor_search - First observed
anyapi_post_v1_run_trustpilot_reviews - First observed
anyapi_post_v1_run_truthsocial_post - First observed
anyapi_post_v1_run_truthsocial_profile - First observed
anyapi_post_v1_run_truthsocial_user_posts - First observed
anyapi_post_v1_run_twitter_article - First observed
anyapi_post_v1_run_twitter_community - First observed
anyapi_post_v1_run_twitter_community_tweets - First observed
anyapi_post_v1_run_twitter_followers - First observed
anyapi_post_v1_run_twitter_following - First observed
anyapi_post_v1_run_twitter_profile - First observed
anyapi_post_v1_run_twitter_replies - First observed
anyapi_post_v1_run_twitter_search - First observed
anyapi_post_v1_run_twitter_search_users - First observed
anyapi_post_v1_run_twitter_thread - First observed
anyapi_post_v1_run_twitter_trends - First observed
anyapi_post_v1_run_twitter_tweet - First observed
anyapi_post_v1_run_twitter_tweet_transcript - First observed
anyapi_post_v1_run_twitter_user_posts - First observed
anyapi_post_v1_run_upwork_jobs - First observed
anyapi_post_v1_run_walmart_product - First observed
anyapi_post_v1_run_web_map - First observed
anyapi_post_v1_run_web_scrape - First observed
anyapi_post_v1_run_web_screenshot - First observed
anyapi_post_v1_run_weibo_hot_search - First observed
anyapi_post_v1_run_weibo_post - First observed
anyapi_post_v1_run_weibo_post_comments - First observed
anyapi_post_v1_run_weibo_profile - First observed
anyapi_post_v1_run_weibo_search - First observed
anyapi_post_v1_run_weibo_user_posts - First observed
anyapi_post_v1_run_yelp_search - First observed
anyapi_post_v1_run_youtube_channel_playlists - First observed
anyapi_post_v1_run_youtube_comment_replies - First observed
anyapi_post_v1_run_youtube_community_post - First observed
anyapi_post_v1_run_youtube_playlist - First observed
anyapi_post_v1_run_youtube_search - First observed
anyapi_post_v1_run_youtube_search_hashtag - First observed
anyapi_post_v1_run_youtube_search_shorts - First observed
anyapi_post_v1_run_youtube_trending_shorts - First observed
anyapi_post_v1_run_youtube_video_comments - First observed
anyapi_post_v1_run_youtube_video_sponsors - First observed
anyapi_post_v1_run_youtube_video_transcript_full - First observed
anyapi_post_v1_run_zhihu_answer - First observed
anyapi_post_v1_run_zhihu_profile - First observed
anyapi_post_v1_run_zhihu_question - First observed
anyapi_post_v1_run_zhihu_question_answers - First observed
anyapi_post_v1_run_zhihu_search_articles - First observed
anyapi_post_v1_run_zillow_agent - First observed
anyapi_post_v1_run_zillow_property - First observed
anyapi_post_v1_run_zillow_search - First observed
blockrun_get_api_v1_commodity_list - First observed
blockrun_get_api_v1_commodity_price_symbol - First observed
blockrun_get_api_v1_crypto_history_symbol - First observed
blockrun_get_api_v1_crypto_list - First observed
blockrun_get_api_v1_crypto_price_symbol - First observed
blockrun_get_api_v1_fx_list - First observed
blockrun_get_api_v1_fx_price_symbol - First observed
blockrun_get_api_v1_stocks_market_list - First observed
blockrun_get_api_v1_usstock_list - First observed
blockrun_get_api_v1_zerox_gasless_chains - First observed
blockrun_get_api_v1_zerox_gasless_price - First observed
blockrun_get_api_v1_zerox_gasless_quote - First observed
blockrun_get_api_v1_zerox_gasless_status_trade_hash - First observed
blockrun_get_api_v1_zerox_price - First observed
blockrun_get_api_v1_zerox_quote - First observed
blockrun_get_api_v1_zerox_swap_chains - First observed
blockrun_get_v1_defillama_chains - First observed
blockrun_get_v1_defillama_prices_coins - First observed
blockrun_get_v1_defillama_protocol_slug - First observed
blockrun_get_v1_defillama_protocols - First observed
blockrun_get_v1_defillama_yields - First observed
blockrun_get_v1_pm_binance_candles_symbol - First observed
blockrun_get_v1_pm_binance_ticks_symbol - First observed
blockrun_get_v1_pm_kalshi_markets - First observed
blockrun_get_v1_pm_kalshi_orderbooks - First observed
blockrun_get_v1_pm_kalshi_trades - First observed
blockrun_get_v1_pm_limitless_markets - First observed
blockrun_get_v1_pm_limitless_orderbooks - First observed
blockrun_get_v1_pm_markets_search - First observed
blockrun_get_v1_pm_opinion_markets - First observed
blockrun_get_v1_pm_opinion_orderbooks - First observed
blockrun_get_v1_pm_polymarket_activity - First observed
blockrun_get_v1_pm_polymarket_candlesticks_condition_id - First observed
blockrun_get_v1_pm_polymarket_candlesticks_token_token_id - First observed
blockrun_get_v1_pm_polymarket_cohorts_stats - First observed
blockrun_get_v1_pm_polymarket_crypto_updown - First observed
blockrun_get_v1_pm_polymarket_events - First observed
blockrun_get_v1_pm_polymarket_events_keyset - First observed
blockrun_get_v1_pm_polymarket_leaderboard - First observed
blockrun_get_v1_pm_polymarket_leaderboard_market_condition_id - First observed
blockrun_get_v1_pm_polymarket_market_condition_id_smart_money - First observed
blockrun_get_v1_pm_polymarket_market_condition_id_top_holders - First observed
blockrun_get_v1_pm_polymarket_market_price_token_id - First observed
blockrun_get_v1_pm_polymarket_markets - First observed
blockrun_get_v1_pm_polymarket_markets_condition_id_open_interest - First observed
blockrun_get_v1_pm_polymarket_markets_keyset - First observed
blockrun_get_v1_pm_polymarket_markets_smart_activity - First observed
blockrun_get_v1_pm_polymarket_markets_token_id_volume - First observed
blockrun_get_v1_pm_polymarket_orderbooks - First observed
blockrun_get_v1_pm_polymarket_positions - First observed
blockrun_get_v1_pm_polymarket_trades - First observed
blockrun_get_v1_pm_polymarket_uma_market_condition_id - First observed
blockrun_get_v1_pm_polymarket_uma_markets - First observed
blockrun_get_v1_pm_polymarket_volume_chart_condition_id - First observed
blockrun_get_v1_pm_polymarket_wallet_identity_wallet - First observed
blockrun_get_v1_pm_polymarket_wallet_markets_wallet - First observed
blockrun_get_v1_pm_polymarket_wallet_pnl_wallet - First observed
blockrun_get_v1_pm_polymarket_wallet_positions_wallet - First observed
blockrun_get_v1_pm_polymarket_wallet_similar_wallet - First observed
blockrun_get_v1_pm_polymarket_wallet_volume_chart_wallet - First observed
blockrun_get_v1_pm_polymarket_wallet_wallet - First observed
blockrun_get_v1_pm_polymarket_wallets_filter - First observed
blockrun_get_v1_pm_polymarket_wallets_profiles - First observed
blockrun_get_v1_pm_predictfun_markets - First observed
blockrun_get_v1_pm_predictfun_orderbooks - First observed
blockrun_post_v1_exa_find_similar - First observed
blockrun_post_v1_exa_search - First observed
blockrun_post_v1_phone_lookup - First observed
blockrun_post_v1_phone_lookup_fraud - First observed
blockrun_post_v1_pm_polymarket_wallet_identities - First observed
blockrun_post_v1_rpc_network - First observed
blockrun_post_v1_search - First observed
blockrun_post_v1_solana_rpc - First observed
blockscout_get_chain_id_api_v2_addresses - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_beac - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_bloc - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_celo - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_co_2 - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_coin - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_coun - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_inte - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_logs - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_nf_2 - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_nft - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_tabs - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_to_2 - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_to_3 - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_toke - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_tran - First observed
blockscout_get_chain_id_api_v2_addresses_address_hash_param_with - First observed
blockscout_get_chain_id_api_v2_advanced_filters - First observed
blockscout_get_chain_id_api_v2_advanced_filters_methods - First observed
blockscout_get_chain_id_api_v2_arbitrum_batches - First observed
blockscout_get_chain_id_api_v2_arbitrum_batches_count - First observed
blockscout_get_chain_id_api_v2_arbitrum_batches_da_anytrust_data - First observed
blockscout_get_chain_id_api_v2_arbitrum_batches_da_celestia_heig - First observed
blockscout_get_chain_id_api_v2_arbitrum_batches_da_eigenda_data - First observed
blockscout_get_chain_id_api_v2_arbitrum_messages_claim_message_i - First observed
blockscout_get_chain_id_api_v2_arbitrum_messages_direction - First observed
blockscout_get_chain_id_api_v2_arbitrum_messages_withdrawals_tra - First observed
blockscout_get_chain_id_api_v2_beacon_deposits - First observed
blockscout_get_chain_id_api_v2_beacon_deposits_count - First observed
blockscout_get_chain_id_api_v2_blocks - First observed
blockscout_get_chain_id_api_v2_blocks_arbitrum_batch_batch_numbe - First observed
blockscout_get_chain_id_api_v2_blocks_block_hash_or_number_par_2 - First observed
blockscout_get_chain_id_api_v2_blocks_block_hash_or_number_param - First observed
blockscout_get_chain_id_api_v2_blocks_optimism_batch_batch_numbe - First observed
blockscout_get_chain_id_api_v2_blocks_scroll_batch_batch_number - First observed
blockscout_get_chain_id_api_v2_celo_epochs - First observed
blockscout_get_chain_id_api_v2_celo_epochs_number - First observed
blockscout_get_chain_id_api_v2_celo_epochs_number_election_rewar - First observed
blockscout_get_chain_id_api_v2_internal_transactions - First observed
blockscout_get_chain_id_api_v2_main_page_arbitrum_batches_commit - First observed
blockscout_get_chain_id_api_v2_main_page_arbitrum_batches_latest - First observed
blockscout_get_chain_id_api_v2_main_page_arbitrum_messages_to_ro - First observed
blockscout_get_chain_id_api_v2_main_page_blocks - First observed
blockscout_get_chain_id_api_v2_main_page_indexing_status - First observed
blockscout_get_chain_id_api_v2_main_page_optimism_deposits - First observed
blockscout_get_chain_id_api_v2_main_page_transactions - First observed
blockscout_get_chain_id_api_v2_optimism_batches - First observed
blockscout_get_chain_id_api_v2_optimism_batches_count - First observed
blockscout_get_chain_id_api_v2_optimism_batches_da_celestia_heig - First observed
blockscout_get_chain_id_api_v2_optimism_deposits - First observed
blockscout_get_chain_id_api_v2_optimism_deposits_count - First observed
blockscout_get_chain_id_api_v2_optimism_games - First observed
blockscout_get_chain_id_api_v2_optimism_games_count - First observed
blockscout_get_chain_id_api_v2_optimism_output_roots - First observed
blockscout_get_chain_id_api_v2_optimism_output_roots_count - First observed
blockscout_get_chain_id_api_v2_optimism_withdrawals - First observed
blockscout_get_chain_id_api_v2_optimism_withdrawals_count - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_accou_2 - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_account - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_bundl_2 - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_bundler - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_bundles - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_facto_2 - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_factori - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_opera_2 - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_opera_3 - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_operati - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_payma_2 - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_paymast - First observed
blockscout_get_chain_id_api_v2_proxy_account_abstraction_status - First observed
blockscout_get_chain_id_api_v2_scroll_batches - First observed
blockscout_get_chain_id_api_v2_scroll_batches_count - First observed
blockscout_get_chain_id_api_v2_scroll_deposits - First observed
blockscout_get_chain_id_api_v2_scroll_deposits_count - First observed
blockscout_get_chain_id_api_v2_scroll_withdrawals - First observed
blockscout_get_chain_id_api_v2_scroll_withdrawals_count - First observed
blockscout_get_chain_id_api_v2_search - First observed
blockscout_get_chain_id_api_v2_search_check_redirect - First observed
blockscout_get_chain_id_api_v2_search_quick - First observed
blockscout_get_chain_id_api_v2_shibarium_deposits - First observed
blockscout_get_chain_id_api_v2_shibarium_deposits_count - First observed
blockscout_get_chain_id_api_v2_shibarium_withdrawals - First observed
blockscout_get_chain_id_api_v2_shibarium_withdrawals_count - First observed
blockscout_get_chain_id_api_v2_smart_contracts - First observed
blockscout_get_chain_id_api_v2_smart_contracts_address_hash_para - First observed
blockscout_get_chain_id_api_v2_smart_contracts_counters - First observed
blockscout_get_chain_id_api_v2_stats - First observed
blockscout_get_chain_id_api_v2_stats_charts_market - First observed
blockscout_get_chain_id_api_v2_stats_charts_secondary_coin_marke - First observed
blockscout_get_chain_id_api_v2_stats_charts_transactions - First observed
blockscout_get_chain_id_api_v2_stats_hot_smart_contracts - First observed
blockscout_get_chain_id_api_v2_token_transfers - First observed
blockscout_get_chain_id_api_v2_tokens - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_counter - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_holders - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_2 - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_3 - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_4 - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_5 - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_insta_6 - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_instanc - First observed
blockscout_get_chain_id_api_v2_tokens_address_hash_param_transfe - First observed
blockscout_get_chain_id_api_v2_transactions - First observed
blockscout_get_chain_id_api_v2_transactions_arbitrum_batch_batch - First observed
blockscout_get_chain_id_api_v2_transactions_optimism_batch_batch - First observed
blockscout_get_chain_id_api_v2_transactions_scroll_batch_batch_n - First observed
blockscout_get_chain_id_api_v2_transactions_stats - First observed
blockscout_get_chain_id_api_v2_transactions_transaction_hash_par - First observed
blockscout_get_chain_id_api_v2_validators_stability - First observed
blockscout_get_chain_id_api_v2_validators_stability_counters - First observed
blockscout_get_chain_id_api_v2_validators_zilliqa - First observed
blockscout_get_chain_id_api_v2_validators_zilliqa_bls_public_key - First observed
blockscout_get_chain_id_api_v2_withdrawals - First observed
blockscout_get_chain_id_api_v2_withdrawals_counters - First observed
coingecko_extra_get_api_v3_coins_id - First observed
coingecko_extra_get_api_v3_derivatives_exchanges_id - First observed
coingecko_extra_get_api_v3_entity_public_treasury_coin_id - First observed
coingecko_extra_get_api_v3_exchanges_id - First observed
coingecko_extra_get_api_v3_nfts_id - First observed
coingecko_extra_get_api_v3_onchain_networks_network_pools_pool_2 - First observed
coingecko_extra_get_api_v3_onchain_networks_network_pools_pool_a - First observed
coingecko_extra_get_api_v3_onchain_networks_network_tokens_multi - First observed
coingecko_extra_get_api_v3_rwas_id - First observed
coingecko_extra_get_api_v3_rwas_issuers_id - First observed
coingecko_get_api_v3_asset_platforms - First observed
coingecko_get_api_v3_coins_categories - First observed
coingecko_get_api_v3_coins_categories_list - First observed
coingecko_get_api_v3_coins_id_contract_contract_address - First observed
coingecko_get_api_v3_coins_id_contract_contract_address_market_2 - First observed
coingecko_get_api_v3_coins_id_contract_contract_address_market_c - First observed
coingecko_get_api_v3_coins_id_history - First observed
coingecko_get_api_v3_coins_id_market_chart - First observed
coingecko_get_api_v3_coins_id_market_chart_range - First observed
coingecko_get_api_v3_coins_id_ohlc - First observed
coingecko_get_api_v3_coins_id_tickers - First observed
coingecko_get_api_v3_coins_list - First observed
coingecko_get_api_v3_coins_markets - First observed
coingecko_get_api_v3_derivatives - First observed
coingecko_get_api_v3_derivatives_exchanges - First observed
coingecko_get_api_v3_derivatives_exchanges_list - First observed
coingecko_get_api_v3_entities_list - First observed
coingecko_get_api_v3_exchange_rates - First observed
coingecko_get_api_v3_exchanges - First observed
coingecko_get_api_v3_exchanges_id_tickers - First observed
coingecko_get_api_v3_exchanges_id_volume_chart - First observed
coingecko_get_api_v3_exchanges_list - First observed
coingecko_get_api_v3_global - First observed
coingecko_get_api_v3_global_decentralized_finance_defi - First observed
coingecko_get_api_v3_nfts_asset_platform_id_contract_contract_ad - First observed
coingecko_get_api_v3_nfts_list - First observed
coingecko_get_api_v3_onchain_networks - First observed
coingecko_get_api_v3_onchain_networks_network_dexes - First observed
coingecko_get_api_v3_onchain_networks_network_dexes_dex_pools - First observed
coingecko_get_api_v3_onchain_networks_network_new_pools - First observed
coingecko_get_api_v3_onchain_networks_network_pools - First observed
coingecko_get_api_v3_onchain_networks_network_pools_address - First observed
coingecko_get_api_v3_onchain_networks_network_pools_multi_addres - First observed
coingecko_get_api_v3_onchain_networks_network_pools_pool_address - First observed
coingecko_get_api_v3_onchain_networks_network_tokens_address - First observed
coingecko_get_api_v3_onchain_networks_network_tokens_address_inf - First observed
coingecko_get_api_v3_onchain_networks_network_tokens_token_addre - First observed
coingecko_get_api_v3_onchain_networks_network_trending_pools - First observed
coingecko_get_api_v3_onchain_networks_new_pools - First observed
coingecko_get_api_v3_onchain_networks_trending_pools - First observed
coingecko_get_api_v3_onchain_search_pools - First observed
coingecko_get_api_v3_onchain_simple_networks_network_token_price - First observed
coingecko_get_api_v3_onchain_tokens_info_recently_updated - First observed
coingecko_get_api_v3_public_treasury_entity_id - First observed
coingecko_get_api_v3_public_treasury_entity_id_coin_id_holding_c - First observed
coingecko_get_api_v3_public_treasury_entity_id_transaction_histo - First observed
coingecko_get_api_v3_rwas_issuers_list - First observed
coingecko_get_api_v3_rwas_list - First observed
coingecko_get_api_v3_rwas_markets - First observed
coingecko_get_api_v3_search - First observed
coingecko_get_api_v3_search_trending - First observed
coingecko_get_api_v3_simple_price - First observed
coingecko_get_api_v3_simple_supported_vs_currencies - First observed
coingecko_get_api_v3_simple_token_price_id - First observed
coingecko_get_api_v3_token_lists_asset_platform_id_all_json - First observed
context_dev_get_v1_web_fonts - First observed
context_dev_get_v1_web_scrape_sitemap - First observed
context_dev_get_v1_web_styleguide - First observed
context_dev_post_v1_brand_ai_product - First observed
context_dev_post_v1_brand_retrieve - First observed
context_dev_post_v1_brand_transaction_identifier - First observed
context_dev_post_v1_company_search - First observed
context_dev_post_v1_news_search - First observed
context_dev_post_v1_people_enrich - First observed
context_dev_post_v1_people_search - First observed
context_dev_post_v1_web_answers - First observed
context_dev_post_v1_web_crawl - First observed
context_dev_post_v1_web_extract - First observed
context_dev_post_v1_web_scrape_html - First observed
context_dev_post_v1_web_scrape_images - First observed
context_dev_post_v1_web_scrape_markdown - First observed
context_dev_post_v1_web_screenshot - First observed
context_dev_post_v1_web_search - First observed
dataforseo_post_v3_ai_optimization_ai_keyword_data_keywords_sear - First observed
dataforseo_post_v3_ai_optimization_chat_gpt_llm_scraper_live_adv - First observed
dataforseo_post_v3_ai_optimization_chat_gpt_llm_scraper_live_htm - First observed
dataforseo_post_v3_ai_optimization_gemini_llm_scraper_live_advan - First observed
dataforseo_post_v3_ai_optimization_gemini_llm_scraper_live_html - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_multi_target_met - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_search_mentions - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_target_metrics_2 - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_target_metrics_l - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_2 - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_3 - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_4 - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_5 - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_6 - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_br - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_do - First observed
dataforseo_post_v3_ai_optimization_llm_mentions_top_mentioned_pa - First observed
dataforseo_post_v3_app_data_apple_app_listings_search_live - First observed
dataforseo_post_v3_app_data_google_app_listings_search_live - First observed
dataforseo_post_v3_backlinks_anchors_live - First observed
dataforseo_post_v3_backlinks_backlinks_live - First observed
dataforseo_post_v3_backlinks_bulk_backlinks_live - First observed
dataforseo_post_v3_backlinks_bulk_new_lost_backlinks_live - First observed
dataforseo_post_v3_backlinks_bulk_new_lost_referring_domains_liv - First observed
dataforseo_post_v3_backlinks_bulk_pages_summary_live - First observed
dataforseo_post_v3_backlinks_bulk_ranks_live - First observed
dataforseo_post_v3_backlinks_bulk_referring_domains_live - First observed
dataforseo_post_v3_backlinks_bulk_spam_score_live - First observed
dataforseo_post_v3_backlinks_competitors_live - First observed
dataforseo_post_v3_backlinks_domain_intersection_live - First observed
dataforseo_post_v3_backlinks_domain_pages_live - First observed
dataforseo_post_v3_backlinks_domain_pages_summary_live - First observed
dataforseo_post_v3_backlinks_page_intersection_live - First observed
dataforseo_post_v3_backlinks_referring_domains_live - First observed
dataforseo_post_v3_backlinks_referring_networks_live - First observed
dataforseo_post_v3_backlinks_summary_live - First observed
dataforseo_post_v3_business_data_business_listings_categories_ag - First observed
dataforseo_post_v3_business_data_business_listings_search_live - First observed
dataforseo_post_v3_business_data_google_hotel_info_live_advanced - First observed
dataforseo_post_v3_business_data_google_hotel_info_live_html - First observed
dataforseo_post_v3_business_data_google_hotel_searches_live - First observed
dataforseo_post_v3_business_data_google_my_business_info_live - First observed
dataforseo_post_v3_business_data_google_questions_and_answers_li - First observed
dataforseo_post_v3_content_analysis_rating_distribution_live - First observed
dataforseo_post_v3_content_analysis_search_live - First observed
dataforseo_post_v3_content_analysis_sentiment_analysis_live - First observed
dataforseo_post_v3_content_analysis_summary_live - First observed
dataforseo_post_v3_dataforseo_labs_amazon_bulk_search_volume_liv - First observed
dataforseo_post_v3_dataforseo_labs_amazon_product_competitors_li - First observed
dataforseo_post_v3_dataforseo_labs_amazon_product_keyword_inters - First observed
dataforseo_post_v3_dataforseo_labs_amazon_product_rank_overview - First observed
dataforseo_post_v3_dataforseo_labs_amazon_ranked_keywords_live - First observed
dataforseo_post_v3_dataforseo_labs_amazon_related_keywords_live - First observed
dataforseo_post_v3_dataforseo_labs_google_bulk_keyword_difficult - First observed
dataforseo_post_v3_dataforseo_labs_google_bulk_traffic_estimatio - First observed
dataforseo_post_v3_dataforseo_labs_google_categories_for_domain - First observed
dataforseo_post_v3_dataforseo_labs_google_categories_for_keyword - First observed
dataforseo_post_v3_dataforseo_labs_google_competitors_domain_liv - First observed
dataforseo_post_v3_dataforseo_labs_google_domain_intersection_li - First observed
dataforseo_post_v3_dataforseo_labs_google_domain_metrics_by_cate - First observed
dataforseo_post_v3_dataforseo_labs_google_domain_rank_overview_l - First observed
dataforseo_post_v3_dataforseo_labs_google_historical_bulk_traffi - First observed
dataforseo_post_v3_dataforseo_labs_google_historical_keyword_dat - First observed
dataforseo_post_v3_dataforseo_labs_google_historical_serps_live - First observed
dataforseo_post_v3_dataforseo_labs_google_keyword_ideas_live - First observed
dataforseo_post_v3_dataforseo_labs_google_keyword_overview_live - First observed
dataforseo_post_v3_dataforseo_labs_google_keywords_for_categorie - First observed
dataforseo_post_v3_dataforseo_labs_google_keywords_for_site_live - First observed
dataforseo_post_v3_dataforseo_labs_google_page_intersection_live - First observed
dataforseo_post_v3_dataforseo_labs_google_ranked_keywords_live - First observed
dataforseo_post_v3_dataforseo_labs_google_related_keywords_live - First observed
dataforseo_post_v3_dataforseo_labs_google_relevant_pages_live - First observed
dataforseo_post_v3_dataforseo_labs_google_search_intent_live - First observed
dataforseo_post_v3_dataforseo_labs_google_serp_competitors_live - First observed
dataforseo_post_v3_dataforseo_labs_google_subdomains_live - First observed
dataforseo_post_v3_dataforseo_labs_google_top_searches_live - First observed
dataforseo_post_v3_domain_analytics_technologies_aggregation_tec - First observed
dataforseo_post_v3_domain_analytics_technologies_domain_technolo - First observed
dataforseo_post_v3_domain_analytics_technologies_domains_by_html - First observed
dataforseo_post_v3_domain_analytics_technologies_domains_by_tech - First observed
dataforseo_post_v3_domain_analytics_whois_overview_live - First observed
dataforseo_post_v3_keywords_data_bing_audience_estimation_live - First observed
dataforseo_post_v3_keywords_data_bing_keyword_performance_live - First observed
dataforseo_post_v3_keywords_data_bing_keywords_for_keywords_live - First observed
dataforseo_post_v3_keywords_data_bing_keywords_for_site_live - First observed
dataforseo_post_v3_keywords_data_bing_search_volume_history_live - First observed
dataforseo_post_v3_keywords_data_bing_search_volume_live - First observed
dataforseo_post_v3_keywords_data_clickstream_data_bulk_search_vo - First observed
dataforseo_post_v3_keywords_data_clickstream_data_dataforseo_sea - First observed
dataforseo_post_v3_keywords_data_clickstream_data_global_search - First observed
dataforseo_post_v3_keywords_data_dataforseo_trends_demography_li - First observed
dataforseo_post_v3_keywords_data_dataforseo_trends_explore_live - First observed
dataforseo_post_v3_keywords_data_dataforseo_trends_merged_data_l - First observed
dataforseo_post_v3_keywords_data_dataforseo_trends_subregion_int - First observed
dataforseo_post_v3_keywords_data_google_ads_ad_traffic_by_keywor - First observed
dataforseo_post_v3_keywords_data_google_ads_keywords_for_keyword - First observed
dataforseo_post_v3_keywords_data_google_ads_keywords_for_site_li - First observed
dataforseo_post_v3_keywords_data_google_ads_search_volume_live - First observed
dataforseo_post_v3_keywords_data_google_trends_explore_live - First observed
dataforseo_post_v3_merchant_amazon_asin_live_advanced - First observed
dataforseo_post_v3_merchant_amazon_asin_live_html - First observed
dataforseo_post_v3_merchant_amazon_products_live_advanced - First observed
dataforseo_post_v3_merchant_amazon_products_live_html - First observed
dataforseo_post_v3_merchant_amazon_sellers_live_advanced - First observed
dataforseo_post_v3_merchant_amazon_sellers_live_html - First observed
dataforseo_post_v3_on_page_content_parsing_live - First observed
dataforseo_post_v3_on_page_instant_pages - First observed
dataforseo_post_v3_on_page_lighthouse_live_json - First observed
dataforseo_post_v3_on_page_page_screenshot - First observed
dataforseo_post_v3_serp_bing_organic_live_advanced - First observed
dataforseo_post_v3_serp_bing_organic_live_html - First observed
dataforseo_post_v3_serp_bing_organic_live_regular - First observed
dataforseo_post_v3_serp_google_ai_mode_live_advanced - First observed
dataforseo_post_v3_serp_google_ai_mode_live_html - First observed
dataforseo_post_v3_serp_google_autocomplete_live_advanced - First observed
dataforseo_post_v3_serp_google_dataset_info_live_advanced - First observed
dataforseo_post_v3_serp_google_dataset_search_live_advanced - First observed
dataforseo_post_v3_serp_google_finance_explore_live_advanced - First observed
dataforseo_post_v3_serp_google_finance_explore_live_html - First observed
dataforseo_post_v3_serp_google_finance_markets_live_advanced - First observed
dataforseo_post_v3_serp_google_finance_markets_live_html - First observed
dataforseo_post_v3_serp_google_finance_quote_live_advanced - First observed
dataforseo_post_v3_serp_google_finance_quote_live_html - First observed
dataforseo_post_v3_serp_google_finance_ticker_search_live_advanc - First observed
dataforseo_post_v3_serp_google_images_live_advanced - First observed
dataforseo_post_v3_serp_google_images_live_html - First observed
dataforseo_post_v3_serp_google_local_finder_live_advanced - First observed
dataforseo_post_v3_serp_google_local_finder_live_html - First observed
dataforseo_post_v3_serp_google_maps_live_advanced - First observed
dataforseo_post_v3_serp_google_news_live_advanced - First observed
dataforseo_post_v3_serp_google_news_live_html - First observed
dataforseo_post_v3_serp_google_organic_live_advanced - First observed
dataforseo_post_v3_serp_google_organic_live_html - First observed
dataforseo_post_v3_serp_google_organic_live_regular - First observed
dataforseo_post_v3_serp_yahoo_organic_live_advanced - First observed
dataforseo_post_v3_serp_yahoo_organic_live_html - First observed
dataforseo_post_v3_serp_yahoo_organic_live_regular - First observed
dataforseo_post_v3_serp_youtube_organic_live_advanced - First observed
dataforseo_post_v3_serp_youtube_video_comments_live_advanced - First observed
dataforseo_post_v3_serp_youtube_video_info_live_advanced - First observed
dataforseo_post_v3_serp_youtube_video_subtitles_live_advanced - First observed
defillama_get_batchhistorical - First observed
defillama_get_block_chain_timestamp - First observed
defillama_get_chart_coins - First observed
defillama_get_overview_dexs - First observed
defillama_get_overview_dexs_chain - First observed
defillama_get_overview_fees - First observed
defillama_get_overview_fees_chain - First observed
defillama_get_overview_open_interest - First observed
defillama_get_overview_options - First observed
defillama_get_overview_options_chain - First observed
defillama_get_percentage_coins - First observed
defillama_get_prices_current_coins - First observed
defillama_get_prices_first_coins - First observed
defillama_get_prices_historical_timestamp_coins - First observed
defillama_get_protocol_protocol - First observed
defillama_get_protocols - First observed
defillama_get_stablecoin_asset - First observed
defillama_get_stablecoinchains - First observed
defillama_get_stablecoincharts_all - First observed
defillama_get_stablecoinprices - First observed
defillama_get_stablecoins - First observed
defillama_get_summary_dexs_protocol - First observed
defillama_get_summary_fees_protocol - First observed
defillama_get_summary_options_protocol - First observed
defillama_get_tvl_protocol - First observed
defillama_get_v2_chains - First observed
defillama_get_v2_historicalchaintvl - First observed
defillama_get_v2_historicalchaintvl_chain - First observed
dexscreener_get_ads_latest_v1 - First observed
dexscreener_get_community_takeovers_latest_v1 - First observed
dexscreener_get_latest_dex_pairs_chainid_pairid - First observed
dexscreener_get_latest_dex_search - First observed
dexscreener_get_metas_meta_v1_slug - First observed
dexscreener_get_metas_trending_v1 - First observed
dexscreener_get_orders_v1_chainid_tokenaddress - First observed
dexscreener_get_token_boosts_latest_v1 - First observed
dexscreener_get_token_boosts_top_v1 - First observed
dexscreener_get_token_pairs_v1_chainid_tokenaddress - First observed
dexscreener_get_token_profiles_latest_v1 - First observed
dexscreener_get_token_profiles_recent_updates_v1 - First observed
dexscreener_get_tokens_v1_chainid_tokenaddresses - First observed
financialdatasets_get_activist_ownership - First observed
financialdatasets_get_beneficial_ownership - First observed
financialdatasets_get_company_facts - First observed
financialdatasets_get_earnings - First observed
financialdatasets_get_filings - First observed
financialdatasets_get_financial_metrics - First observed
financialdatasets_get_financial_metrics_snapshot - First observed
financialdatasets_get_financials - First observed
financialdatasets_get_financials_as_reported - First observed
financialdatasets_get_financials_balance_sheets - First observed
financialdatasets_get_financials_balance_sheets_as_reported - First observed
financialdatasets_get_financials_balance_sheets_segments - First observed
financialdatasets_get_financials_cash_flow_statements - First observed
financialdatasets_get_financials_cash_flow_statements_as_reporte - First observed
financialdatasets_get_financials_cash_flow_statements_segments - First observed
financialdatasets_get_financials_income_statements - First observed
financialdatasets_get_financials_income_statements_as_reported - First observed
financialdatasets_get_financials_income_statements_segments - First observed
financialdatasets_get_financials_segments - First observed
financialdatasets_get_index_funds - First observed
financialdatasets_get_insider_ownership - First observed
financialdatasets_get_insider_trades - First observed
financialdatasets_get_institutional_holdings - First observed
financialdatasets_get_ipos - First observed
financialdatasets_get_kpi_guidance - First observed
financialdatasets_get_kpi_metrics - First observed
financialdatasets_get_kpi_non_gaap - First observed
financialdatasets_get_macro_gpu_prices - First observed
financialdatasets_get_macro_gpu_prices_snapshot - First observed
financialdatasets_get_macro_inflation - First observed
financialdatasets_get_macro_inflation_snapshot - First observed
financialdatasets_get_macro_interest_rates - First observed
financialdatasets_get_macro_interest_rates_snapshot - First observed
financialdatasets_get_macro_labor - First observed
financialdatasets_get_macro_labor_snapshot - First observed
financialdatasets_get_macro_yield_curve - First observed
financialdatasets_get_macro_yield_curve_snapshot - First observed
financialdatasets_get_news - First observed
financialdatasets_get_prices - First observed
financialdatasets_get_prices_snapshot - First observed
financialdatasets_post_financials_search_line_items - First observed
financialdatasets_post_financials_search_screener - First observed
fred_get_fred_category - First observed
fred_get_fred_category_children - First observed
fred_get_fred_category_related - First observed
fred_get_fred_category_related_tags - First observed
fred_get_fred_category_series - First observed
fred_get_fred_category_tags - First observed
fred_get_fred_related_tags - First observed
fred_get_fred_release - First observed
fred_get_fred_release_dates - First observed
fred_get_fred_release_related_tags - First observed
fred_get_fred_release_series - First observed
fred_get_fred_release_sources - First observed
fred_get_fred_release_tables - First observed
fred_get_fred_release_tags - First observed
fred_get_fred_releases - First observed
fred_get_fred_releases_dates - First observed
fred_get_fred_series - First observed
fred_get_fred_series_categories - First observed
fred_get_fred_series_observations - First observed
fred_get_fred_series_release - First observed
fred_get_fred_series_search - First observed
fred_get_fred_series_search_related_tags - First observed
fred_get_fred_series_search_tags - First observed
fred_get_fred_series_tags - First observed
fred_get_fred_series_updates - First observed
fred_get_fred_series_vintagedates - First observed
fred_get_fred_source - First observed
fred_get_fred_source_releases - First observed
fred_get_fred_sources - First observed
fred_get_fred_tags - First observed
fred_get_fred_tags_series - First observed
fred_get_geofred_regional_data - First observed
fred_get_geofred_series_data - First observed
fred_get_geofred_series_group - First observed
fred_get_geofred_shapes_file - First observed
gang_get_api_agents_id - First observed
gang_get_api_agents_id_launches - First observed
gang_get_api_agents_id_positions - First observed
gang_get_api_agents_id_trades - First observed
gang_get_api_featured - First observed
gang_get_api_fly_tokens_addr - First observed
gang_get_api_fly_tokens_addr_events - First observed
gang_get_api_fly_tokens_addr_holders - First observed
gang_get_api_fly_tokens_addr_participants - First observed
gang_get_api_fly_tokens_addr_position_wallet - First observed
gang_get_api_fly_tokens_addr_referrals - First observed
gang_get_api_fly_tokens_addr_trades - First observed
gang_get_api_market - First observed
gang_get_api_notes - First observed
gang_get_api_notes_tx - First observed
gang_get_api_openapi_json - First observed
gang_get_api_ref_eligible - First observed
gang_get_api_search - First observed
gang_get_api_share - First observed
gang_get_api_stats - First observed
gang_get_api_trending - First observed
geckoterminal_get_api_v2_networks - First observed
geckoterminal_get_api_v2_networks_network_dexes - First observed
geckoterminal_get_api_v2_networks_network_dexes_dex_pools - First observed
geckoterminal_get_api_v2_networks_network_new_pools - First observed
geckoterminal_get_api_v2_networks_network_pools - First observed
geckoterminal_get_api_v2_networks_network_pools_address - First observed
geckoterminal_get_api_v2_networks_network_pools_multi_addresses - First observed
geckoterminal_get_api_v2_networks_network_pools_pool_address_ohl - First observed
geckoterminal_get_api_v2_networks_network_tokens_address - First observed
geckoterminal_get_api_v2_networks_network_tokens_address_info - First observed
geckoterminal_get_api_v2_networks_network_tokens_token_address_p - First observed
geckoterminal_get_api_v2_networks_network_trending_pools - First observed
geckoterminal_get_api_v2_networks_new_pools - First observed
geckoterminal_get_api_v2_networks_trending_pools - First observed
geckoterminal_get_api_v2_search_pools - First observed
geckoterminal_get_api_v2_simple_networks_network_token_price_add - First observed
geckoterminal_get_api_v2_tokens_info_recently_updated - First observed
goplus_get_api_v1_address_security_address - First observed
goplus_get_api_v1_approval_security_chain_id - First observed
goplus_get_api_v1_nft_security_chain_id - First observed
goplus_get_api_v1_phishing_site - First observed
goplus_get_api_v1_rugpull_detecting_chain_id - First observed
goplus_get_api_v1_solana_token_security - First observed
goplus_get_api_v1_sui_token_security - First observed
goplus_get_api_v1_supported_chains - First observed
goplus_get_api_v1_token_security_chain_id - First observed
goplus_get_api_v2_nft1155_approval_security_chainid - First observed
goplus_get_api_v2_nft721_approval_security_chainid - First observed
goplus_get_api_v2_token_approval_security_chainid - First observed
harvestapi_get_linkedin_account_search - First observed
harvestapi_get_linkedin_comment_reactions - First observed
harvestapi_get_linkedin_company_posts - First observed
harvestapi_get_linkedin_company_search - First observed
harvestapi_get_linkedin_job - First observed
harvestapi_get_linkedin_job_search - First observed
harvestapi_get_linkedin_lead_search - First observed
harvestapi_get_linkedin_post - First observed
harvestapi_get_linkedin_post_comment_replies - First observed
harvestapi_get_linkedin_post_comments - First observed
harvestapi_get_linkedin_post_reactions - First observed
harvestapi_get_linkedin_post_search - First observed
harvestapi_get_linkedin_profile_comments - First observed
harvestapi_get_linkedin_profile_posts - First observed
harvestapi_get_linkedin_profile_reactions - First observed
harvestapi_get_linkedin_profile_search - First observed
hunter_get_v2_combined_find - First observed
hunter_get_v2_companies_find - First observed
hunter_get_v2_discover_people - First observed
hunter_get_v2_domain_finder - First observed
hunter_get_v2_domain_search - First observed
hunter_get_v2_email_count - First observed
hunter_get_v2_email_finder - First observed
hunter_get_v2_email_verifier - First observed
hunter_get_v2_people_find - First observed
hunter_post_v2_discover - First observed
hunter_post_v2_discover_people - First observed
hunter_post_v2_domain_search - First observed
hunter_post_v2_multi_domain_search - First observed
hunter_post_v2_multi_domain_search_reveal - First observed
hyperliquid_post_info_active_asset_data - First observed
hyperliquid_post_info_all_borrow_lend_reserve_states - First observed
hyperliquid_post_info_all_mids - First observed
hyperliquid_post_info_all_perp_metas - First observed
hyperliquid_post_info_approved_builders - First observed
hyperliquid_post_info_borrow_lend_reserve_state - First observed
hyperliquid_post_info_borrow_lend_user_state - First observed
hyperliquid_post_info_candle_snapshot - First observed
hyperliquid_post_info_clearinghouse_state - First observed
hyperliquid_post_info_delegations - First observed
hyperliquid_post_info_delegator_history - First observed
hyperliquid_post_info_delegator_rewards - First observed
hyperliquid_post_info_delegator_summary - First observed
hyperliquid_post_info_frontend_open_orders - First observed
hyperliquid_post_info_funding_history - First observed
hyperliquid_post_info_historical_orders - First observed
hyperliquid_post_info_l2_book - First observed
hyperliquid_post_info_max_builder_fee - First observed
hyperliquid_post_info_meta - First observed
hyperliquid_post_info_meta_and_asset_ctxs - First observed
hyperliquid_post_info_open_orders - First observed
hyperliquid_post_info_order_status - First observed
hyperliquid_post_info_outcome_deployer_limits - First observed
hyperliquid_post_info_outcome_meta - First observed
hyperliquid_post_info_outcome_templates - First observed
hyperliquid_post_info_perp_annotation - First observed
hyperliquid_post_info_perp_categories - First observed
hyperliquid_post_info_perp_concise_annotations - First observed
hyperliquid_post_info_perp_deploy_auction_status - First observed
hyperliquid_post_info_perp_dex_limits - First observed
hyperliquid_post_info_perp_dex_status - First observed
hyperliquid_post_info_perp_dexs - First observed
hyperliquid_post_info_perps_at_open_interest_cap - First observed
hyperliquid_post_info_portfolio - First observed
hyperliquid_post_info_predicted_fundings - First observed
hyperliquid_post_info_referral - First observed
hyperliquid_post_info_settled_outcome - First observed
hyperliquid_post_info_spot_clearinghouse_state - First observed
hyperliquid_post_info_spot_deploy_state - First observed
hyperliquid_post_info_spot_meta - First observed
hyperliquid_post_info_spot_meta_and_asset_ctxs - First observed
hyperliquid_post_info_spot_pair_deploy_auction_status - First observed
hyperliquid_post_info_sub_accounts - First observed
hyperliquid_post_info_token_details - First observed
hyperliquid_post_info_user_abstraction - First observed
hyperliquid_post_info_user_dex_abstraction - First observed
hyperliquid_post_info_user_fees - First observed
hyperliquid_post_info_user_fills - First observed
hyperliquid_post_info_user_fills_by_time - First observed
hyperliquid_post_info_user_funding - First observed
hyperliquid_post_info_user_non_funding_ledger_updates - First observed
hyperliquid_post_info_user_rate_limit - First observed
hyperliquid_post_info_user_role - First observed
hyperliquid_post_info_user_twap_slice_fills - First observed
hyperliquid_post_info_user_vault_equities - First observed
hyperliquid_post_info_vault_details - First observed
jupiter_delete_prediction_v1_positions_positionpubkey - First observed
jupiter_get_lend_v1_borrow_positions - First observed
jupiter_get_lend_v1_borrow_vaults - First observed
jupiter_get_lend_v1_earn_earnings - First observed
jupiter_get_lend_v1_earn_positions - First observed
jupiter_get_lend_v1_earn_tokens - First observed
jupiter_get_prediction_v1_events - First observed
jupiter_get_prediction_v1_events_eventid_markets - First observed
jupiter_get_prediction_v1_events_eventid_markets_marketid - First observed
jupiter_get_prediction_v1_events_eventid_score - First observed
jupiter_get_prediction_v1_history - First observed
jupiter_get_prediction_v1_leaderboards - First observed
jupiter_get_prediction_v1_markets_marketid - First observed
jupiter_get_prediction_v1_orderbook_marketid - First observed
jupiter_get_prediction_v1_orders - First observed
jupiter_get_prediction_v1_orders_orderpubkey - First observed
jupiter_get_prediction_v1_orders_status_orderpubkey - First observed
jupiter_get_prediction_v1_positions - First observed
jupiter_get_prediction_v1_positions_positionpubkey - First observed
jupiter_get_prediction_v1_profiles_ownerpubkey - First observed
jupiter_get_prediction_v1_trades - First observed
jupiter_get_prediction_v1_trading_status - First observed
jupiter_get_prediction_v1_vault_info - First observed
jupiter_get_price_v3 - First observed
jupiter_get_query_prediction_jupiter_prediction_api_get_event_79 - First observed
jupiter_get_query_prediction_jupiter_prediction_api_get_live_sco - First observed
jupiter_get_query_prediction_jupiter_prediction_api_search_event - First observed
jupiter_get_send_v1_invite_history - First observed
jupiter_get_send_v1_pending_invites - First observed
jupiter_get_swap_v2_build - First observed
jupiter_get_swap_v2_order - First observed
jupiter_get_swap_v2_program_id_to_label - First observed
jupiter_get_tokens_v2_category_interval - First observed
jupiter_get_tokens_v2_recent - First observed
jupiter_get_tokens_v2_search - First observed
jupiter_get_tokens_v2_tag - First observed
jupiter_get_tokens_v2_verify_express_check_eligibility - First observed
jupiter_post_lend_v1_borrow_operate - First observed
jupiter_post_lend_v1_borrow_operate_instructions - First observed
jupiter_post_lend_v1_earn_deposit - First observed
jupiter_post_lend_v1_earn_deposit_instructions - First observed
jupiter_post_lend_v1_earn_mint - First observed
jupiter_post_lend_v1_earn_mint_instructions - First observed
jupiter_post_lend_v1_earn_redeem - First observed
jupiter_post_lend_v1_earn_redeem_instructions - First observed
jupiter_post_lend_v1_earn_withdraw - First observed
jupiter_post_lend_v1_earn_withdraw_instructions - First observed
justoneapi_get_api_1688_get_category_info_v1 - First observed
justoneapi_get_api_1688_get_category_item_list_v1 - First observed
justoneapi_get_api_1688_get_category_item_list_v2 - First observed
justoneapi_get_api_1688_get_item_description_images_v1 - First observed
justoneapi_get_api_1688_get_item_detail_by_url_v1 - First observed
justoneapi_get_api_1688_get_item_detail_v1 - First observed
justoneapi_get_api_1688_get_item_detail_v2 - First observed
justoneapi_get_api_1688_get_item_rating_list_v1 - First observed
justoneapi_get_api_1688_get_item_shipping_v1 - First observed
justoneapi_get_api_1688_get_shop_category_v1 - First observed
justoneapi_get_api_1688_get_shop_info_v1 - First observed
justoneapi_get_api_1688_get_shop_item_list_by_url_v1 - First observed
justoneapi_get_api_1688_get_shop_item_list_v1 - First observed
justoneapi_get_api_1688_search_cross_border_item_by_image_v1 - First observed
justoneapi_get_api_1688_search_cross_border_item_by_image_v2 - First observed
justoneapi_get_api_1688_search_cross_border_item_list_v1 - First observed
justoneapi_get_api_1688_search_factory_v1 - First observed
justoneapi_get_api_1688_search_item_by_image_v1 - First observed
justoneapi_get_api_1688_search_item_list_v1 - First observed
justoneapi_get_api_1688_search_item_list_v2 - First observed
justoneapi_get_api_aliexpress_get_product_detail_v1 - First observed
justoneapi_get_api_aliexpress_search_products_v1 - First observed
justoneapi_get_api_amazon_get_best_sellers_v1 - First observed
justoneapi_get_api_amazon_get_category_products_v1 - First observed
justoneapi_get_api_amazon_get_product_detail_v1 - First observed
justoneapi_get_api_amazon_get_product_top_reviews_v1 - First observed
justoneapi_get_api_amazon_search_products_v1 - First observed
justoneapi_get_api_bilibili_get_user_detail_v2 - First observed
justoneapi_get_api_bilibili_get_user_relation_stat_v1 - First observed
justoneapi_get_api_bilibili_get_user_video_list_v2 - First observed
justoneapi_get_api_bilibili_get_video_caption_v2 - First observed
justoneapi_get_api_bilibili_get_video_comment_v2 - First observed
justoneapi_get_api_bilibili_get_video_danmu_v2 - First observed
justoneapi_get_api_bilibili_get_video_detail_v2 - First observed
justoneapi_get_api_bilibili_search_video_v2 - First observed
justoneapi_get_api_bilibili_share_url_transfer_v1 - First observed
justoneapi_get_api_douban_get_movie_comments_v1 - First observed
justoneapi_get_api_douban_get_movie_review_detail_v1 - First observed
justoneapi_get_api_douban_get_movie_reviews_v1 - First observed
justoneapi_get_api_douban_get_recent_hot_movie_v1 - First observed
justoneapi_get_api_douban_get_recent_hot_tv_v1 - First observed
justoneapi_get_api_douban_get_subject_detail_v1 - First observed
justoneapi_get_api_douyin_ec_get_item_comments_v1 - First observed
justoneapi_get_api_douyin_ec_get_item_detail_v2 - First observed
justoneapi_get_api_douyin_ec_get_item_sku_info_v1 - First observed
justoneapi_get_api_douyin_ec_get_item_sku_info_v2 - First observed
justoneapi_get_api_douyin_ec_get_shop_item_list_v1 - First observed
justoneapi_get_api_douyin_ec_search_item_list_v1 - First observed
justoneapi_get_api_douyin_get_user_detail_v3 - First observed
justoneapi_get_api_douyin_get_user_video_list_v1 - First observed
justoneapi_get_api_douyin_get_user_video_list_v3 - First observed
justoneapi_get_api_douyin_get_video_comment_v1 - First observed
justoneapi_get_api_douyin_get_video_detail_v2 - First observed
justoneapi_get_api_douyin_get_video_sub_comment_v1 - First observed
justoneapi_get_api_douyin_hot_search_v1 - First observed
justoneapi_get_api_douyin_search_image_v1 - First observed
justoneapi_get_api_douyin_search_user_v2 - First observed
justoneapi_get_api_douyin_search_video_v4 - First observed
justoneapi_get_api_douyin_share_url_transfer_v1 - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_2 - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_3 - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_4 - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_co - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_ho - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_li - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_or - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_si - First observed
justoneapi_get_api_douyin_xingtu_gw_api_aggregator_get_author_ta - First observed
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_base_i - First observed
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_market - First observed
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_platfo - First observed
justoneapi_get_api_douyin_xingtu_gw_api_author_get_author_show_i - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_get_author_hot_comm - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_audience - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_cp_info_v - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_link_stru - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_rec_video - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_touch_dis - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_author_video_dis - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_check_author_dis - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_con_2 - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_conve - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_daily - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_fans - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_link - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_get_author_sprea - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_item_report_deta - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_item_report_th_a - First observed
justoneapi_get_api_douyin_xingtu_gw_api_data_sp_item_report_tren - First observed
justoneapi_get_api_douyin_xingtu_gw_api_gauthor_author_get_busin - First observed
justoneapi_get_api_douyin_xingtu_gw_api_gauthor_get_author_conte - First observed
justoneapi_get_api_douyin_xingtu_gw_api_gsearch_search_for_autho - First observed
justoneapi_get_api_facebook_get_comment_replies_v1 - First observed
justoneapi_get_api_facebook_get_post_comments_v1 - First observed
justoneapi_get_api_facebook_get_profile_id_v1 - First observed
justoneapi_get_api_facebook_get_profile_posts_v1 - First observed
justoneapi_get_api_facebook_search_post_v1 - First observed
justoneapi_get_api_imdb_news_by_category_query_v1 - First observed
justoneapi_get_api_imdb_streaming_picks_query_v1 - First observed
justoneapi_get_api_imdb_title_awards_summary_query_v1 - First observed
justoneapi_get_api_imdb_title_base_query_v1 - First observed
justoneapi_get_api_imdb_title_box_office_summary_v1 - First observed
justoneapi_get_api_imdb_title_chart_rankings_v1 - First observed
justoneapi_get_api_imdb_title_contribution_questions_v1 - First observed
justoneapi_get_api_imdb_title_countries_of_origin_v1 - First observed
justoneapi_get_api_imdb_title_critics_review_summary_query_v1 - First observed
justoneapi_get_api_imdb_title_details_query_v1 - First observed
justoneapi_get_api_imdb_title_did_you_know_query_v1 - First observed
justoneapi_get_api_imdb_title_extended_details_query_v1 - First observed
justoneapi_get_api_imdb_title_more_like_this_query_v1 - First observed
justoneapi_get_api_imdb_title_plot_query_v1 - First observed
justoneapi_get_api_imdb_title_redux_overview_query_v1 - First observed
justoneapi_get_api_imdb_title_release_expectation_query_v1 - First observed
justoneapi_get_api_imdb_title_top_cast_and_crew_v1 - First observed
justoneapi_get_api_imdb_title_user_reviews_summary_query_v1 - First observed
justoneapi_get_api_instagram_general_search_v1 - First observed
justoneapi_get_api_instagram_get_comment_replies_v1 - First observed
justoneapi_get_api_instagram_get_post_comments_v1 - First observed
justoneapi_get_api_instagram_get_post_detail_v1 - First observed
justoneapi_get_api_instagram_get_user_detail_v1 - First observed
justoneapi_get_api_instagram_get_user_detail_v2 - First observed
justoneapi_get_api_instagram_get_user_posts_v1 - First observed
justoneapi_get_api_instagram_search_hashtag_posts_v1 - First observed
justoneapi_get_api_instagram_search_reels_v1 - First observed
justoneapi_get_api_jd_get_item_comments_v1 - First observed
justoneapi_get_api_jd_get_item_description_images_v1 - First observed
justoneapi_get_api_jd_get_item_detail_v1 - First observed
justoneapi_get_api_jd_get_item_detail_v3 - First observed
justoneapi_get_api_jd_get_item_detail_v4 - First observed
justoneapi_get_api_jd_get_item_price_v1 - First observed
justoneapi_get_api_jd_get_shop_item_list_v1 - First observed
justoneapi_get_api_jd_search_item_list_v1 - First observed
justoneapi_get_api_kuaishou_get_user_detail_v1 - First observed
justoneapi_get_api_kuaishou_get_user_video_list_v2 - First observed
justoneapi_get_api_kuaishou_get_video_comment_v1 - First observed
justoneapi_get_api_kuaishou_get_video_detail_v2 - First observed
justoneapi_get_api_kuaishou_search_user_v2 - First observed
justoneapi_get_api_kuaishou_search_video_v1 - First observed
justoneapi_get_api_kuaishou_search_video_v2 - First observed
justoneapi_get_api_kuaishou_share_url_transfer_v1 - First observed
justoneapi_get_api_linkedin_get_post_comments_v1 - First observed
justoneapi_get_api_linkedin_get_user_detail_v1 - First observed
justoneapi_get_api_linkedin_get_user_posts_v1 - First observed
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publish_2 - First observed
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publish_3 - First observed
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publish_4 - First observed
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_finder_publisher - First observed
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_mp_publisher_det - First observed
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_mp_publisher_get - First observed
justoneapi_get_api_qq_huxuan_cgi_bin_advertiser_mp_publisher_sea - First observed
justoneapi_get_api_reddit_get_post_comments_v1 - First observed
justoneapi_get_api_reddit_get_post_detail_v1 - First observed
justoneapi_get_api_reddit_search_v1 - First observed
justoneapi_get_api_search_v1 - First observed
justoneapi_get_api_shopee_get_item_detail_v1 - First observed
justoneapi_get_api_shopee_get_item_detail_v2 - First observed
justoneapi_get_api_shopee_get_item_installments_v1 - First observed
justoneapi_get_api_shopee_get_item_review_models_v1 - First observed
justoneapi_get_api_shopee_get_item_review_tags_v1 - First observed
justoneapi_get_api_shopee_get_item_reviews_v1 - First observed
justoneapi_get_api_shopee_get_item_sku_matrix_v1 - First observed
justoneapi_get_api_shopee_get_item_sku_models_v1 - First observed
justoneapi_get_api_shopee_get_item_snapshot_v1 - First observed
justoneapi_get_api_shopee_get_search_facets_v1 - First observed
justoneapi_get_api_shopee_get_shop_base_v1 - First observed
justoneapi_get_api_shopee_get_shop_categories_v1 - First observed
justoneapi_get_api_shopee_get_shop_detail_v1 - First observed
justoneapi_get_api_shopee_get_shop_item_list_v1 - First observed
justoneapi_get_api_shopee_get_shop_reviews_rich_v1 - First observed
justoneapi_get_api_shopee_get_shop_reviews_v1 - First observed
justoneapi_get_api_shopee_get_shop_seo_v1 - First observed
justoneapi_get_api_shopee_search_item_list_v1 - First observed
justoneapi_get_api_taobao_get_item_comment_v3 - First observed
justoneapi_get_api_taobao_get_item_description_v1 - First observed
justoneapi_get_api_taobao_get_item_detail_v1 - First observed
justoneapi_get_api_taobao_get_item_detail_v2 - First observed
justoneapi_get_api_taobao_get_item_detail_v3 - First observed
justoneapi_get_api_taobao_get_item_detail_v4 - First observed
justoneapi_get_api_taobao_get_item_detail_v5 - First observed
justoneapi_get_api_taobao_get_item_detail_v6 - First observed
justoneapi_get_api_taobao_get_item_detail_v8 - First observed
justoneapi_get_api_taobao_get_item_detail_v9 - First observed
justoneapi_get_api_taobao_get_shop_item_list_v1 - First observed
justoneapi_get_api_taobao_get_shop_item_list_v2 - First observed
justoneapi_get_api_taobao_get_shop_item_list_v3 - First observed
justoneapi_get_api_taobao_get_shop_item_list_v4 - First observed
justoneapi_get_api_taobao_get_social_feed_v1 - First observed
justoneapi_get_api_taobao_search_item_list_v1 - First observed
justoneapi_get_api_taobao_search_item_list_v2 - First observed
justoneapi_get_api_tiktok_get_post_comment_v1 - First observed
justoneapi_get_api_tiktok_get_post_detail_v1 - First observed
justoneapi_get_api_tiktok_get_post_sub_comment_v1 - First observed
justoneapi_get_api_tiktok_get_user_detail_v1 - First observed
justoneapi_get_api_tiktok_get_user_post_v1 - First observed
justoneapi_get_api_tiktok_search_post_v1 - First observed
justoneapi_get_api_tiktok_shop_get_product_detail_v1 - First observed
justoneapi_get_api_tiktok_shop_search_products_v1 - First observed
justoneapi_get_api_toutiao_get_article_detail_v1 - First observed
justoneapi_get_api_toutiao_get_user_detail_v1 - First observed
justoneapi_get_api_toutiao_get_user_id_v1 - First observed
justoneapi_get_api_toutiao_get_video_detail_v1 - First observed
justoneapi_get_api_toutiao_search_v2 - First observed
justoneapi_get_api_twitter_get_post_comments_v1 - First observed
justoneapi_get_api_twitter_get_post_detail_v1 - First observed
justoneapi_get_api_twitter_get_user_detail_v1 - First observed
justoneapi_get_api_twitter_get_user_posts_v1 - First observed
justoneapi_get_api_twitter_search_v1 - First observed
justoneapi_get_api_weibo_get_fans_v1 - First observed
justoneapi_get_api_weibo_get_followers_v1 - First observed
justoneapi_get_api_weibo_get_post_comments_v1 - First observed
justoneapi_get_api_weibo_get_user_detail_v3 - First observed
justoneapi_get_api_weibo_get_user_post_v1 - First observed
justoneapi_get_api_weibo_get_user_video_list_v1 - First observed
justoneapi_get_api_weibo_get_weibo_detail_v1 - First observed
justoneapi_get_api_weibo_hot_search_v1 - First observed
justoneapi_get_api_weibo_search_all_v2 - First observed
justoneapi_get_api_weibo_search_profile_v1 - First observed
justoneapi_get_api_weibo_tv_component_v1 - First observed
justoneapi_get_api_weixin_channels_convert_export_id_v1 - First observed
justoneapi_get_api_weixin_channels_get_bound_channel_v1 - First observed
justoneapi_get_api_weixin_channels_get_video_basic_info_v1 - First observed
justoneapi_get_api_weixin_channels_get_video_download_url_v1 - First observed
justoneapi_get_api_weixin_channels_get_video_share_url_v1 - First observed
justoneapi_get_api_weixin_channels_get_video_title_v1 - First observed
justoneapi_get_api_weixin_convert_article_link_v1 - First observed
justoneapi_get_api_weixin_get_account_basic_info_v1 - First observed
justoneapi_get_api_weixin_get_account_original_count_v1 - First observed
justoneapi_get_api_weixin_get_account_principal_info_v1 - First observed
justoneapi_get_api_weixin_get_article_detail_v1 - First observed
justoneapi_get_api_weixin_get_article_detail_v2 - First observed
justoneapi_get_api_weixin_get_article_detail_v3 - First observed
justoneapi_get_api_weixin_get_article_detail_v4 - First observed
justoneapi_get_api_weixin_get_article_detail_v5 - First observed
justoneapi_get_api_weixin_get_article_metrics_v1 - First observed
justoneapi_get_api_weixin_get_article_metrics_v2 - First observed
justoneapi_get_api_weixin_get_article_sub_comment_v1 - First observed
justoneapi_get_api_weixin_search_suggestions_v1 - First observed
justoneapi_get_api_weixin_search_wechat_index_v1 - First observed
justoneapi_get_api_xianyu_get_item_detail_v1 - First observed
justoneapi_get_api_xianyu_search_item_list_v1 - First observed
justoneapi_get_api_xiaohongshu_ask_dots - First observed
justoneapi_get_api_xiaohongshu_ec_search_products_v1 - First observed
justoneapi_get_api_xiaohongshu_get_creator_hot_inspiration_feed - First observed
justoneapi_get_api_xiaohongshu_get_note_comment_v2 - First observed
justoneapi_get_api_xiaohongshu_get_note_detail_v1 - First observed
justoneapi_get_api_xiaohongshu_get_note_detail_v6 - First observed
justoneapi_get_api_xiaohongshu_get_note_sub_comment_v2 - First observed
justoneapi_get_api_xiaohongshu_get_topic_note_list_v1 - First observed
justoneapi_get_api_xiaohongshu_get_user_faved_note_list_v1 - First observed
justoneapi_get_api_xiaohongshu_get_user_note_list_v4 - First observed
justoneapi_get_api_xiaohongshu_get_user_v3 - First observed
justoneapi_get_api_xiaohongshu_hot_search_v1 - First observed
justoneapi_get_api_xiaohongshu_pgy_api_pgy_content_square_search - First observed
justoneapi_get_api_xiaohongshu_pgy_api_pgy_kol_data_core_data_v1 - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_cooperator_blogger - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_cooperator_user_blo - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_data_userid_f_2 - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_data_userid_fan - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_costeffe - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_kolconte - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_kolfeatu - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav2_notesdet - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav3_datasumm - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav3_fanssumm - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_datav3_notesrat - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_kol_get_similar_kol - First observed
justoneapi_get_api_xiaohongshu_pgy_api_solar_note_noteid_detail - First observed
justoneapi_get_api_xiaohongshu_pgy_get_kol_note_list_v1 - First observed
justoneapi_get_api_xiaohongshu_search_note_v2 - First observed
justoneapi_get_api_xiaohongshu_search_note_v4 - First observed
justoneapi_get_api_xiaohongshu_search_recommend_v1 - First observed
justoneapi_get_api_xiaohongshu_search_user_v2 - First observed
justoneapi_get_api_xiaohongshu_share_url_transfer_v1 - First observed
justoneapi_get_api_youku_get_user_detail_v1 - First observed
justoneapi_get_api_youku_get_video_detail_v1 - First observed
justoneapi_get_api_youku_search_video_v1 - First observed
justoneapi_get_api_youtube_get_channel_shorts_v1 - First observed
justoneapi_get_api_youtube_get_channel_videos_v1 - First observed
justoneapi_get_api_youtube_get_video_captions_v1 - First observed
justoneapi_get_api_youtube_get_video_comment_v1 - First observed
justoneapi_get_api_youtube_get_video_detail_v1 - First observed
justoneapi_get_api_youtube_get_video_sub_comment_v1 - First observed
justoneapi_get_api_youtube_search_v1 - First observed
justoneapi_get_api_zhihu_get_answer_comments_v1 - First observed
justoneapi_get_api_zhihu_get_answer_list_v1 - First observed
justoneapi_get_api_zhihu_get_column_article_detail_v1 - First observed
justoneapi_get_api_zhihu_get_column_article_list_v1 - First observed
justoneapi_get_api_zhihu_get_comment_replies_v1 - First observed
justoneapi_get_api_zhihu_get_user_articles_v1 - First observed
justoneapi_get_api_zhihu_get_user_follow_collections_v1 - First observed
justoneapi_get_api_zhihu_get_user_follow_columns_v1 - First observed
justoneapi_get_api_zhihu_get_user_follow_topics_v1 - First observed
justoneapi_get_api_zhihu_get_user_followees_v1 - First observed
justoneapi_get_api_zhihu_get_user_followers_v1 - First observed
justoneapi_get_api_zhihu_get_user_included_articles_v1 - First observed
justoneapi_get_api_zhihu_get_user_info_v1 - First observed
justoneapi_get_api_zhihu_search_v1 - First observed
justoneapi_post_api_1688_convert_image_v1 - First observed
justoneapi_post_api_weixin_channels_search_account_v2 - First observed
justoneapi_post_api_weixin_channels_search_account_v3 - First observed
justoneapi_post_api_weixin_search_account_v1 - First observed
keenable_get_v1_fetch_public - First observed
keenable_post_v1_search_public - First observed
lifi_get_v1_analytics_transfers - First observed
lifi_get_v1_analytics_transfers_summary - First observed
lifi_get_v1_calldata_parse - First observed
lifi_get_v1_chains - First observed
lifi_get_v1_connections - First observed
lifi_get_v1_gas_prices - First observed
lifi_get_v1_gas_prices_chainid - First observed
lifi_get_v1_gas_suggestion_chain - First observed
lifi_get_v1_quote - First observed
lifi_get_v1_quote_toamount - First observed
lifi_get_v1_status - First observed
lifi_get_v1_token - First observed
lifi_get_v1_tokens - First observed
lifi_get_v1_tools - First observed
lifi_get_v2_analytics_transfers - First observed
lifi_post_v1_advanced_routes - First observed
lifi_post_v1_advanced_steptransaction - First observed
lifi_post_v1_quote_contractcalls - First observed
litescrape_post_api_airbnb_search - First observed
litescrape_post_api_aliexpress_product - First observed
litescrape_post_api_aliexpress_search - First observed
litescrape_post_api_amazon_autocomplete - First observed
litescrape_post_api_amazon_featured_reviews - First observed
litescrape_post_api_amazon_media_reviews - First observed
litescrape_post_api_amazon_product - First observed
litescrape_post_api_amazon_search - First observed
litescrape_post_api_apartments_property - First observed
litescrape_post_api_apartments_search - First observed
litescrape_post_api_apple_app_store_product - First observed
litescrape_post_api_apple_app_store_reviews - First observed
litescrape_post_api_apple_app_store_search - First observed
litescrape_post_api_apple_maps_places - First observed
litescrape_post_api_apple_maps_reviews - First observed
litescrape_post_api_ashby_search - First observed
litescrape_post_api_baidu_search - First observed
litescrape_post_api_bestbuy_product - First observed
litescrape_post_api_bestbuy_search - First observed
litescrape_post_api_bing_images - First observed
litescrape_post_api_bing_maps - First observed
litescrape_post_api_bing_product - First observed
litescrape_post_api_bing_search - First observed
litescrape_post_api_bing_shopping - First observed
litescrape_post_api_brave_ai_mode - First observed
litescrape_post_api_brave_search - First observed
litescrape_post_api_duckduckgo_maps - First observed
litescrape_post_api_duckduckgo_search - First observed
litescrape_post_api_ebay_product - First observed
litescrape_post_api_ebay_search - First observed
litescrape_post_api_ebay_seller - First observed
litescrape_post_api_etsy_product - First observed
litescrape_post_api_etsy_search - First observed
litescrape_post_api_eventbrite_search - First observed
litescrape_post_api_facebook_hashtag_posts - First observed
litescrape_post_api_facebook_marketplace_browse - First observed
litescrape_post_api_facebook_page_posts - First observed
litescrape_post_api_facebook_post - First observed
litescrape_post_api_facebook_reel - First observed
litescrape_post_api_facebook_search_pages - First observed
litescrape_post_api_facebook_search_profiles - First observed
litescrape_post_api_glassdoor_search - First observed
litescrape_post_api_google_ads - First observed
litescrape_post_api_google_ai_mode - First observed
litescrape_post_api_google_ai_overview - First observed
litescrape_post_api_google_contributor_reviews - First observed
litescrape_post_api_google_gemini - First observed
litescrape_post_api_google_images - First observed
litescrape_post_api_google_jobs - First observed
litescrape_post_api_google_local - First observed
litescrape_post_api_google_maps - First observed
litescrape_post_api_google_maps_photo_meta - First observed
litescrape_post_api_google_maps_popular_times - First observed
litescrape_post_api_google_maps_posts - First observed
litescrape_post_api_google_play_apps - First observed
litescrape_post_api_google_play_books - First observed
litescrape_post_api_google_play_games - First observed
litescrape_post_api_google_play_movies - First observed
litescrape_post_api_google_play_product - First observed
litescrape_post_api_google_play_reviews - First observed
litescrape_post_api_google_reviews - First observed
litescrape_post_api_google_search - First observed
litescrape_post_api_google_shopping - First observed
litescrape_post_api_google_shopping_merchant_urls - First observed
litescrape_post_api_google_shopping_product - First observed
litescrape_post_api_homedepot_product - First observed
litescrape_post_api_homedepot_search - First observed
litescrape_post_api_homes_property - First observed
litescrape_post_api_homes_search - First observed
litescrape_post_api_ikea_product - First observed
litescrape_post_api_ikea_search - First observed
litescrape_post_api_indeed_search - First observed
litescrape_post_api_instagram_embed - First observed
litescrape_post_api_instagram_post - First observed
litescrape_post_api_instagram_posts - First observed
litescrape_post_api_instagram_profile - First observed
litescrape_post_api_instagram_profile_post_count - First observed
litescrape_post_api_instagram_search_popular - First observed
litescrape_post_api_kroger_product - First observed
litescrape_post_api_kroger_search - First observed
litescrape_post_api_levels_search - First observed
litescrape_post_api_naver_ai_overview - First observed
litescrape_post_api_naver_search - First observed
litescrape_post_api_realtor_property - First observed
litescrape_post_api_realtor_search - First observed
litescrape_post_api_redfin_property - First observed
litescrape_post_api_redfin_search - First observed
litescrape_post_api_sprouts_product - First observed
litescrape_post_api_sprouts_search - First observed
litescrape_post_api_target_product - First observed
litescrape_post_api_target_search - First observed
litescrape_post_api_tiktok_collection_videos - First observed
litescrape_post_api_tiktok_comment_replies - First observed
litescrape_post_api_tiktok_comments - First observed
litescrape_post_api_tiktok_followers - First observed
litescrape_post_api_tiktok_following - First observed
litescrape_post_api_tiktok_live - First observed
litescrape_post_api_tiktok_profile - First observed
litescrape_post_api_tiktok_profile_videos - First observed
litescrape_post_api_tiktok_search_hashtag - First observed
litescrape_post_api_tiktok_search_keyword - First observed
litescrape_post_api_tiktok_search_suggestions - First observed
litescrape_post_api_tiktok_search_top - First observed
litescrape_post_api_tiktok_song - First observed
litescrape_post_api_tiktok_song_videos - First observed
litescrape_post_api_tiktok_transcript - First observed
litescrape_post_api_tiktok_trending_feed - First observed
litescrape_post_api_tiktok_user_live - First observed
litescrape_post_api_tiktok_video - First observed
litescrape_post_api_tripadvisor_place - First observed
litescrape_post_api_tripadvisor_reviews - First observed
litescrape_post_api_tripadvisor_search - First observed
litescrape_post_api_walmart_product - First observed
litescrape_post_api_walmart_search - First observed
litescrape_post_api_wayfair_product - First observed
litescrape_post_api_wayfair_search - First observed
litescrape_post_api_web_fetch - First observed
litescrape_post_api_web_screenshot - First observed
litescrape_post_api_wholefoods_product - First observed
litescrape_post_api_wholefoods_search - First observed
litescrape_post_api_x_community - First observed
litescrape_post_api_x_community_posts - First observed
litescrape_post_api_x_post - First observed
litescrape_post_api_x_profile - First observed
litescrape_post_api_x_user_posts - First observed
litescrape_post_api_yahoo_images - First observed
litescrape_post_api_yahoo_search - First observed
litescrape_post_api_yandex_images - First observed
litescrape_post_api_yandex_search - First observed
litescrape_post_api_yelp_reviews - First observed
litescrape_post_api_yelp_search - First observed
litescrape_post_api_youtube_channel - First observed
nws_get_alerts_active - First observed
nws_get_hourly_office_grid - First observed
pkulaw_post_account_get_points_balance - First observed
pkulaw_post_account_list_entitlements - First observed
pkulaw_post_article_keyword_get_law_item_content - First observed
pkulaw_post_case_keyword_get_case_list - First observed
pkulaw_post_case_number_recognition_anhao_recognition - First observed
pkulaw_post_case_semantic_search_case - First observed
pkulaw_post_enforcement_search_enforcement - First observed
pkulaw_post_hyperlinks_get_linked_content - First observed
pkulaw_post_law_keyword_get_law_list - First observed
pkulaw_post_law_recognition_law_recognition - First observed
pkulaw_post_law_semantic_get_article - First observed
pkulaw_post_law_semantic_search_article - First observed
pkulaw_post_legal_search_anhao_recognition - First observed
pkulaw_post_legal_search_diff_article_versions - First observed
pkulaw_post_legal_search_get_article - First observed
pkulaw_post_legal_search_get_article_history - First observed
pkulaw_post_legal_search_get_case_list - First observed
pkulaw_post_legal_search_get_law_item_content - First observed
pkulaw_post_legal_search_get_law_list - First observed
pkulaw_post_legal_search_get_linked_content - First observed
pkulaw_post_legal_search_get_points_balance - First observed
pkulaw_post_legal_search_law_recognition - First observed
pkulaw_post_legal_search_list_entitlements - First observed
pkulaw_post_legal_search_list_law_versions - First observed
pkulaw_post_legal_search_list_related_statutes - First observed
pkulaw_post_legal_search_search_article - First observed
pkulaw_post_legal_search_search_case - First observed
pkulaw_post_legal_search_search_enforcement - First observed
pkulaw_post_legal_search_search_procuratorate - First observed
pkulaw_post_procuratorate_search_procuratorate - First observed
pkulaw_post_statute_history_diff_article_versions - First observed
pkulaw_post_statute_history_get_article_history - First observed
pkulaw_post_statute_history_list_law_versions - First observed
pkulaw_post_statute_history_list_related_statutes - First observed
polymarket_get_book - First observed
polymarket_get_builder_trades - First observed
polymarket_get_clob_markets_condition_id - First observed
polymarket_get_comments - First observed
polymarket_get_comments_id - First observed
polymarket_get_comments_user_address_user_address - First observed
polymarket_get_deployed - First observed
polymarket_get_events - First observed
polymarket_get_events_id_comments_count - First observed
polymarket_get_fee_rate - First observed
polymarket_get_fee_rate_token_id - First observed
polymarket_get_last_trade_price - First observed
polymarket_get_markets - First observed
polymarket_get_markets_by_token_token_id - First observed
polymarket_get_midpoint - First observed
polymarket_get_neg_risk - First observed
polymarket_get_neg_risk_token_id - First observed
polymarket_get_nonce - First observed
polymarket_get_price - First observed
polymarket_get_prices_history - First observed
polymarket_get_profiles_user_address_user_address - First observed
polymarket_get_public_profile - First observed
polymarket_get_public_search - First observed
polymarket_get_query_market_discovery_get_event_by_id_cf500de4_i - First observed
polymarket_get_query_market_discovery_get_event_by_slug_53104e36 - First observed
polymarket_get_query_market_discovery_get_event_creator_by_id_d5 - First observed
polymarket_get_query_market_discovery_get_event_tags_ef161323_id - First observed
polymarket_get_query_market_discovery_get_event_tweet_count_a76c - First observed
polymarket_get_query_market_discovery_get_market_by_id_8bc925ee - First observed
polymarket_get_query_market_discovery_get_market_by_slug_f8868a3 - First observed
polymarket_get_query_market_discovery_get_market_description_by - First observed
polymarket_get_query_market_discovery_get_market_tags_by_id_8edc - First observed
polymarket_get_query_market_discovery_get_related_tags_relations - First observed
polymarket_get_query_market_discovery_get_tag_by_slug_0733a7b9_s - First observed
polymarket_get_query_market_discovery_list_event_creators_fe732d - First observed
polymarket_get_query_market_discovery_list_events_keyset_paginat - First observed
polymarket_get_query_market_discovery_list_events_paginated_f118 - First observed
polymarket_get_query_market_discovery_list_markets_keyset_pagina - First observed
polymarket_get_query_market_discovery_list_sport_events_results - First observed
polymarket_get_query_orderbook_and_prices_get_current_active_rew - First observed
polymarket_get_query_orderbook_and_prices_get_live_activity_mark - First observed
polymarket_get_query_orderbook_and_prices_get_multiple_markets_w - First observed
polymarket_get_query_orderbook_and_prices_get_raw_rewards_for_a - First observed
polymarket_get_rebates_current - First observed
polymarket_get_relay_payload - First observed
polymarket_get_sampling_markets - First observed
polymarket_get_sampling_simplified_markets - First observed
polymarket_get_series - First observed
polymarket_get_series_id - First observed
polymarket_get_series_id_comments_count - First observed
polymarket_get_series_summary_id - First observed
polymarket_get_series_summary_slug_slug - First observed
polymarket_get_simplified_markets - First observed
polymarket_get_sports - First observed
polymarket_get_sports_market_types - First observed
polymarket_get_spread - First observed
polymarket_get_supported_assets - First observed
polymarket_get_tags - First observed
polymarket_get_tags_id - First observed
polymarket_get_tags_id_related_tags_tags - First observed
polymarket_get_tags_slug_slug_related_tags - First observed
polymarket_get_tags_slug_slug_related_tags_tags - First observed
polymarket_get_teams - First observed
polymarket_get_teams_id - First observed
polymarket_get_tick_size - First observed
polymarket_get_tick_size_token_id - First observed
polymarket_get_v1_info_assets - First observed
polymarket_get_v1_info_bbo - First observed
polymarket_get_v1_info_book - First observed
polymarket_get_v1_info_builder - First observed
polymarket_get_v1_info_competition - First observed
polymarket_get_v1_info_competition_account - First observed
polymarket_get_v1_info_competition_leaderboard - First observed
polymarket_get_v1_info_competition_widget - First observed
polymarket_get_v1_info_competitions - First observed
polymarket_get_v1_info_exchange - First observed
polymarket_get_v1_info_exchange_stats - First observed
polymarket_get_v1_info_fees - First observed
polymarket_get_v1_info_funding - First observed
polymarket_get_v1_info_index - First observed
polymarket_get_v1_info_instruments - First observed
polymarket_get_v1_info_invite - First observed
polymarket_get_v1_info_klines - First observed
polymarket_get_v1_info_leaderboard - First observed
polymarket_get_v1_info_limit_tiers - First observed
polymarket_get_v1_info_mark_history - First observed
polymarket_get_v1_info_portfolio - First observed
polymarket_get_v1_info_position_fills - First observed
polymarket_get_v1_info_registered - First observed
polymarket_get_v1_info_statistics - First observed
polymarket_get_v1_info_tickers - First observed
polymarket_get_v1_info_trades - First observed
polymarket_get_v1_rfq_combo_markets - First observed
polymarket_get_v2_activity - First observed
polymarket_get_v2_activity_combos - First observed
polymarket_get_v2_approvals - First observed
polymarket_get_v2_biggest_winners - First observed
polymarket_get_v2_builders_leaderboard - First observed
polymarket_get_v2_builders_volume - First observed
polymarket_get_v2_holders - First observed
polymarket_get_v2_leaderboard - First observed
polymarket_get_v2_live_volume - First observed
polymarket_get_v2_oi - First observed
polymarket_get_v2_positions - First observed
polymarket_get_v2_positions_combos - First observed
polymarket_get_v2_prices_history - First observed
polymarket_get_v2_resolutions - First observed
polymarket_get_v2_status - First observed
polymarket_get_v2_tokens - First observed
polymarket_get_v2_trades - First observed
polymarket_get_v2_user_pnl - First observed
polymarket_get_v2_user_stats - First observed
polymarket_get_v2_user_volume - First observed
polymarket_get_v2_value - First observed
polymarket_post_batch_prices_history - First observed
polymarket_post_books - First observed
polymarket_post_last_trades_prices - First observed
polymarket_post_markets_abridged - First observed
polymarket_post_markets_information - First observed
polymarket_post_markets_live_activity - First observed
polymarket_post_midpoints - First observed
polymarket_post_prices - First observed
polymarket_post_quote - First observed
polymarket_post_spreads - First observed
polymarket_post_v1_info_position_snapshots - First observed
qcc_post_case_get_judicial_authoritative_case_search - First observed
qcc_post_case_get_judicial_case_detail - First observed
qcc_post_case_get_judicial_case_search - First observed
qcc_post_case_get_judicial_citation_verify - First observed
qcc_post_company_get_actual_controller - First observed
qcc_post_company_get_annual_reports - First observed
qcc_post_company_get_beneficial_owners - First observed
qcc_post_company_get_branches - First observed
qcc_post_company_get_change_records - First observed
qcc_post_company_get_company_by_query - First observed
qcc_post_company_get_company_profile - First observed
qcc_post_company_get_company_registration_info - First observed
qcc_post_company_get_contact_info - First observed
qcc_post_company_get_external_investments - First observed
qcc_post_company_get_financial_data - First observed
qcc_post_company_get_key_personnel - First observed
qcc_post_company_get_listing_info - First observed
qcc_post_company_get_shareholder_info - First observed
qcc_post_company_get_tax_invoice_info - First observed
qcc_post_company_verify_company_accuracy - First observed
qcc_post_document_get_parse_result - First observed
qcc_post_document_parse_document - First observed
qcc_post_executive_get_executive_admin_penalty - First observed
qcc_post_executive_get_executive_beneficial_owner - First observed
qcc_post_executive_get_executive_case_filing - First observed
qcc_post_executive_get_executive_controlled_companies - First observed
qcc_post_executive_get_executive_court_notice - First observed
qcc_post_executive_get_executive_dishonest - First observed
qcc_post_executive_get_executive_equity_freeze - First observed
qcc_post_executive_get_executive_equity_pledge - First observed
qcc_post_executive_get_executive_exit_restriction - First observed
qcc_post_executive_get_executive_hearing_notice - First observed
qcc_post_executive_get_executive_high_consumption_ban - First observed
qcc_post_executive_get_executive_historical_admin_penalty - First observed
qcc_post_executive_get_executive_historical_case_filing - First observed
qcc_post_executive_get_executive_historical_court_notice - First observed
qcc_post_executive_get_executive_historical_dishonest - First observed
qcc_post_executive_get_executive_historical_equity_freeze - First observed
qcc_post_executive_get_executive_historical_equity_pledge - First observed
qcc_post_executive_get_executive_historical_hearing_notice - First observed
qcc_post_executive_get_executive_historical_high_consumption_ban - First observed
qcc_post_executive_get_executive_historical_investments - First observed
qcc_post_executive_get_executive_historical_judgment_debtor - First observed
qcc_post_executive_get_executive_historical_judicial_docs - First observed
qcc_post_executive_get_executive_historical_legal_rep_roles - First observed
qcc_post_executive_get_executive_historical_partners - First observed
qcc_post_executive_get_executive_historical_positions - First observed
qcc_post_executive_get_executive_historical_pre_litigation_media - First observed
qcc_post_executive_get_executive_historical_related_companies - First observed
qcc_post_executive_get_executive_historical_service_notice - First observed
qcc_post_executive_get_executive_historical_terminated_cases - First observed
qcc_post_executive_get_executive_investments - First observed
qcc_post_executive_get_executive_judgment_debtor - First observed
qcc_post_executive_get_executive_judicial_docs - First observed
qcc_post_executive_get_executive_legal_rep_roles - First observed
qcc_post_executive_get_executive_positions - First observed
qcc_post_executive_get_executive_pre_litigation_mediation - First observed
qcc_post_executive_get_executive_property_reward_notice - First observed
qcc_post_executive_get_executive_related_companies - First observed
qcc_post_executive_get_executive_related_risk_scan - First observed
qcc_post_executive_get_executive_risk_scan - First observed
qcc_post_executive_get_executive_service_notice - First observed
qcc_post_executive_get_executive_stock_pledge - First observed
qcc_post_executive_get_executive_tax_violation - First observed
qcc_post_executive_get_executive_terminated_cases - First observed
qcc_post_executive_get_executive_valuation_inquiry - First observed
qcc_post_ipr_get_app_info - First observed
qcc_post_ipr_get_commercial_franchise - First observed
qcc_post_ipr_get_copyright_work_info - First observed
qcc_post_ipr_get_douyin_account - First observed
qcc_post_ipr_get_integrated_circuit_layout - First observed
qcc_post_ipr_get_international_patent - First observed
qcc_post_ipr_get_internet_service_info - First observed
qcc_post_ipr_get_ipr_pledge - First observed
qcc_post_ipr_get_kuaishou_account - First observed
qcc_post_ipr_get_mini_program - First observed
qcc_post_ipr_get_online_store - First observed
qcc_post_ipr_get_patent_info - First observed
qcc_post_ipr_get_software_copyright_info - First observed
qcc_post_ipr_get_standard_info - First observed
qcc_post_ipr_get_trademark_document - First observed
qcc_post_ipr_get_trademark_info - First observed
qcc_post_ipr_get_wechat_official_account - First observed
qcc_post_ipr_get_weibo_account - First observed
qcc_post_operation_get_administrative_license - First observed
qcc_post_operation_get_advertising_review - First observed
qcc_post_operation_get_asset_auction - First observed
qcc_post_operation_get_bidding_info - First observed
qcc_post_operation_get_bond_financing_info - First observed
qcc_post_operation_get_company_announcement - First observed
qcc_post_operation_get_counterfeit_cosmetics - First observed
qcc_post_operation_get_credit_commitments - First observed
qcc_post_operation_get_credit_evaluation - First observed
qcc_post_operation_get_entry_denied - First observed
qcc_post_operation_get_financing_lease_info - First observed
qcc_post_operation_get_financing_records - First observed
qcc_post_operation_get_food_safety - First observed
qcc_post_operation_get_game_approval - First observed
qcc_post_operation_get_government_announcement - First observed
qcc_post_operation_get_government_interview - First observed
qcc_post_operation_get_honor_info - First observed
qcc_post_operation_get_import_export_credit - First observed
qcc_post_operation_get_investment_institution - First observed
qcc_post_operation_get_land_grant_info - First observed
qcc_post_operation_get_land_transfer_info - First observed
qcc_post_operation_get_news_sentiment - First observed
qcc_post_operation_get_private_fund_manager - First observed
qcc_post_operation_get_product_recall - First observed
qcc_post_operation_get_product_spot_check - First observed
qcc_post_operation_get_property_rights_transaction - First observed
qcc_post_operation_get_qualifications - First observed
qcc_post_operation_get_random_check - First observed
qcc_post_operation_get_ranking_list_info - First observed
qcc_post_operation_get_recruitment_info - First observed
qcc_post_operation_get_related_announcement - First observed
qcc_post_operation_get_software_violation - First observed
qcc_post_operation_get_spot_check_info - First observed
qcc_post_operation_get_taxpayer_qualification - First observed
qcc_post_operation_get_tech_achievement - First observed
qcc_post_operation_get_telecom_license - First observed
qcc_post_regulation_get_legal_article_detail - First observed
qcc_post_regulation_get_legal_article_search - First observed
qcc_post_regulation_get_legal_article_semantic_search - First observed
qcc_post_regulation_get_legal_citation_verify - First observed
qcc_post_regulation_get_legal_regulation_detail - First observed
qcc_post_regulation_get_legal_regulation_search - First observed
qcc_post_risk_get_administrative_penalty - First observed
qcc_post_risk_get_bankruptcy_reorganization - First observed
qcc_post_risk_get_business_exception - First observed
qcc_post_risk_get_cancellation_record_info - First observed
qcc_post_risk_get_case_filing_info - First observed
qcc_post_risk_get_chattel_mortgage_info - First observed
qcc_post_risk_get_company_related_risk_scan - First observed
qcc_post_risk_get_company_risk_scan - First observed
qcc_post_risk_get_court_notice - First observed
qcc_post_risk_get_default_info - First observed
qcc_post_risk_get_disciplinary_list - First observed
qcc_post_risk_get_dishonest_info - First observed
qcc_post_risk_get_environmental_penalty - First observed
qcc_post_risk_get_equity_freeze - First observed
qcc_post_risk_get_equity_pledge_info - First observed
qcc_post_risk_get_exit_restriction - First observed
qcc_post_risk_get_guarantee_info - First observed
qcc_post_risk_get_hearing_notice - First observed
qcc_post_risk_get_high_consumption_restriction - First observed
qcc_post_risk_get_judgment_debtor_info - First observed
qcc_post_risk_get_judicial_auction - First observed
qcc_post_risk_get_judicial_document_detail - First observed
qcc_post_risk_get_judicial_documents - First observed
qcc_post_risk_get_land_mortgage_info - First observed
qcc_post_risk_get_liquidation_info - First observed
qcc_post_risk_get_pre_litigation_mediation - First observed
qcc_post_risk_get_property_asset_announcement - First observed
qcc_post_risk_get_public_exhortation - First observed
qcc_post_risk_get_serious_violation - First observed
qcc_post_risk_get_service_announcement - First observed
qcc_post_risk_get_service_notice - First observed
qcc_post_risk_get_simple_cancellation_info - First observed
qcc_post_risk_get_stock_pledge_info - First observed
qcc_post_risk_get_tax_abnormal - First observed
qcc_post_risk_get_tax_arrears_notice - First observed
qcc_post_risk_get_tax_violation - First observed
qcc_post_risk_get_terminated_cases - First observed
qcc_post_risk_get_valuation_inquiry - First observed
qcc_post_tender_get_proposed_project_detail - First observed
qcc_post_tender_get_tender_detail - First observed
qcc_post_tender_search_companies - First observed
qcc_post_tender_search_company_tenders - First observed
qcc_post_tender_search_proposed_projects - First observed
qcc_post_tender_search_tenders - First observed
rugcheck_get_v1_domains - First observed
rugcheck_get_v1_domains_lookup_id - First observed
rugcheck_get_v1_leaderboard - First observed
rugcheck_get_v1_search - First observed
rugcheck_get_v1_stats_analytics - First observed
rugcheck_get_v1_stats_new_tokens - First observed
rugcheck_get_v1_stats_recent - First observed
rugcheck_get_v1_stats_rugs_ticker - First observed
rugcheck_get_v1_stats_rugs_top_liquidity - First observed
rugcheck_get_v1_stats_trending - First observed
rugcheck_get_v1_stats_verified - First observed
rugcheck_get_v1_tokens_id_insiders_graph - First observed
rugcheck_get_v1_tokens_id_insiders_networks - First observed
rugcheck_get_v1_tokens_id_report - First observed
rugcheck_get_v1_tokens_id_report_summary - First observed
rugcheck_get_v1_tokens_id_votes - First observed
scrapecreators_get_v1_account_credit_balance - First observed
scrapecreators_get_v1_account_get_api_usage - First observed
scrapecreators_get_v1_account_get_daily_usage_count - First observed
scrapecreators_get_v1_account_get_most_used_routes - First observed
scrapecreators_get_v1_amazon_shop - First observed
scrapecreators_get_v1_apple_music_album - First observed
scrapecreators_get_v1_apple_music_artist - First observed
scrapecreators_get_v1_apple_music_search - First observed
scrapecreators_get_v1_apple_music_track - First observed
scrapecreators_get_v1_bluesky_post - First observed
scrapecreators_get_v1_bluesky_profile - First observed
scrapecreators_get_v1_bluesky_user_posts - First observed
scrapecreators_get_v1_cosmos_cluster - First observed
scrapecreators_get_v1_cosmos_cluster_posts - First observed
scrapecreators_get_v1_cosmos_post - First observed
scrapecreators_get_v1_cosmos_profile - First observed
scrapecreators_get_v1_cosmos_search - First observed
scrapecreators_get_v1_cosmos_user_clusters - First observed
scrapecreators_get_v1_cosmos_user_posts - First observed
scrapecreators_get_v1_detect_age_gender - First observed
scrapecreators_get_v1_facebook_adlibrary_ad - First observed
scrapecreators_get_v1_facebook_adlibrary_company_ads - First observed
scrapecreators_get_v1_facebook_adlibrary_search_ads - First observed
scrapecreators_get_v1_facebook_adlibrary_search_companies - First observed
scrapecreators_get_v1_facebook_event_details - First observed
scrapecreators_get_v1_facebook_events - First observed
scrapecreators_get_v1_facebook_events_search - First observed
scrapecreators_get_v1_facebook_group - First observed
scrapecreators_get_v1_facebook_group_posts - First observed
scrapecreators_get_v1_facebook_marketplace_item - First observed
scrapecreators_get_v1_facebook_marketplace_location_search - First observed
scrapecreators_get_v1_facebook_marketplace_search - First observed
scrapecreators_get_v1_facebook_post - First observed
scrapecreators_get_v1_facebook_post_comment_replies - First observed
scrapecreators_get_v1_facebook_post_comments - First observed
scrapecreators_get_v1_facebook_profile - First observed
scrapecreators_get_v1_facebook_profile_events - First observed
scrapecreators_get_v1_facebook_profile_photos - First observed
scrapecreators_get_v1_facebook_profile_posts - First observed
scrapecreators_get_v1_facebook_profile_reels - First observed
scrapecreators_get_v1_facebook_search_videos - First observed
scrapecreators_get_v1_find_creator_emails - First observed
scrapecreators_get_v1_find_social_profiles - First observed
scrapecreators_get_v1_github_repository - First observed
scrapecreators_get_v1_github_trending_developers - First observed
scrapecreators_get_v1_github_trending_repositories - First observed
scrapecreators_get_v1_github_user - First observed
scrapecreators_get_v1_github_user_activity - First observed
scrapecreators_get_v1_github_user_contributions - First observed
scrapecreators_get_v1_github_user_followers - First observed
scrapecreators_get_v1_github_user_following - First observed
scrapecreators_get_v1_github_user_pull_requests - First observed
scrapecreators_get_v1_github_user_repositories - First observed
scrapecreators_get_v1_google_ad - First observed
scrapecreators_get_v1_google_adlibrary_advertisers_search - First observed
scrapecreators_get_v1_google_company_ads - First observed
scrapecreators_get_v1_google_search - First observed
scrapecreators_get_v1_instagram_audio_reels - First observed
scrapecreators_get_v1_instagram_basic_profile - First observed
scrapecreators_get_v1_instagram_post - First observed
scrapecreators_get_v1_instagram_post_comment_replies - First observed
scrapecreators_get_v1_instagram_profile - First observed
scrapecreators_get_v1_instagram_profile_post_count - First observed
scrapecreators_get_v1_instagram_reels_trending - First observed
scrapecreators_get_v1_instagram_search - First observed
scrapecreators_get_v1_instagram_search_hashtag - First observed
scrapecreators_get_v1_instagram_search_popular - First observed
scrapecreators_get_v1_instagram_search_profiles - First observed
scrapecreators_get_v1_instagram_user_embed - First observed
scrapecreators_get_v1_instagram_user_highlight_detail - First observed
scrapecreators_get_v1_instagram_user_highlights - First observed
scrapecreators_get_v1_instagram_user_reels - First observed
scrapecreators_get_v1_instagram_user_tagged_posts - First observed
scrapecreators_get_v1_kick_clip - First observed
scrapecreators_get_v1_komi - First observed
scrapecreators_get_v1_kwai_post - First observed
scrapecreators_get_v1_kwai_profile - First observed
scrapecreators_get_v1_kwai_user_posts - First observed
scrapecreators_get_v1_linkbio - First observed
scrapecreators_get_v1_linkedin_ad - First observed
scrapecreators_get_v1_linkedin_ads_search - First observed
scrapecreators_get_v1_linkedin_company - First observed
scrapecreators_get_v1_linkedin_company_posts - First observed
scrapecreators_get_v1_linkedin_post - First observed
scrapecreators_get_v1_linkedin_post_transcript - First observed
scrapecreators_get_v1_linkedin_profile - First observed
scrapecreators_get_v1_linkedin_search_posts - First observed
scrapecreators_get_v1_linkme - First observed
scrapecreators_get_v1_linktree - First observed
scrapecreators_get_v1_pillar - First observed
scrapecreators_get_v1_pinterest_board - First observed
scrapecreators_get_v1_pinterest_pin - First observed
scrapecreators_get_v1_pinterest_search - First observed
scrapecreators_get_v1_pinterest_user_boards - First observed
scrapecreators_get_v1_reddit_post - First observed
scrapecreators_get_v1_reddit_post_comments - First observed
scrapecreators_get_v1_reddit_post_transcript - First observed
scrapecreators_get_v1_reddit_search - First observed
scrapecreators_get_v1_reddit_subreddit - First observed
scrapecreators_get_v1_reddit_subreddit_details - First observed
scrapecreators_get_v1_reddit_subreddit_search - First observed
scrapecreators_get_v1_rumble_channel_videos - First observed
scrapecreators_get_v1_rumble_search - First observed
scrapecreators_get_v1_rumble_video - First observed
scrapecreators_get_v1_rumble_video_comments - First observed
scrapecreators_get_v1_rumble_video_transcript - First observed
scrapecreators_get_v1_snapchat_profile - First observed
scrapecreators_get_v1_snapchat_spotlight - First observed
scrapecreators_get_v1_snapchat_spotlight_comments - First observed
scrapecreators_get_v1_soundcloud_artist - First observed
scrapecreators_get_v1_soundcloud_artist_tracks - First observed
scrapecreators_get_v1_soundcloud_track - First observed
scrapecreators_get_v1_spotify_album - First observed
scrapecreators_get_v1_spotify_artist - First observed
scrapecreators_get_v1_spotify_playlist - First observed
scrapecreators_get_v1_spotify_podcast - First observed
scrapecreators_get_v1_spotify_podcast_episodes - First observed
scrapecreators_get_v1_spotify_search - First observed
scrapecreators_get_v1_spotify_track - First observed
scrapecreators_get_v1_telegram_channel - First observed
scrapecreators_get_v1_telegram_channel_posts - First observed
scrapecreators_get_v1_telegram_post - First observed
scrapecreators_get_v1_threads_post - First observed
scrapecreators_get_v1_threads_profile - First observed
scrapecreators_get_v1_threads_search - First observed
scrapecreators_get_v1_threads_search_users - First observed
scrapecreators_get_v1_threads_user_posts - First observed
scrapecreators_get_v1_tiktok_ad_library_ad - First observed
scrapecreators_get_v1_tiktok_ad_library_search - First observed
scrapecreators_get_v1_tiktok_collection_videos - First observed
scrapecreators_get_v1_tiktok_creators_popular - First observed
scrapecreators_get_v1_tiktok_get_trending_feed - First observed
scrapecreators_get_v1_tiktok_live - First observed
scrapecreators_get_v1_tiktok_product - First observed
scrapecreators_get_v1_tiktok_profile - First observed
scrapecreators_get_v1_tiktok_profile_region - First observed
scrapecreators_get_v1_tiktok_search_hashtag - First observed
scrapecreators_get_v1_tiktok_search_keyword - First observed
scrapecreators_get_v1_tiktok_search_suggestions - First observed
scrapecreators_get_v1_tiktok_search_top - First observed
scrapecreators_get_v1_tiktok_search_users - First observed
scrapecreators_get_v1_tiktok_shop_product_reviews - First observed
scrapecreators_get_v1_tiktok_shop_products - First observed
scrapecreators_get_v1_tiktok_shop_search - First observed
scrapecreators_get_v1_tiktok_song - First observed
scrapecreators_get_v1_tiktok_song_videos - First observed
scrapecreators_get_v1_tiktok_user_audience - First observed
scrapecreators_get_v1_tiktok_user_followers - First observed
scrapecreators_get_v1_tiktok_user_following - First observed
scrapecreators_get_v1_tiktok_user_live - First observed
scrapecreators_get_v1_tiktok_user_showcase - First observed
scrapecreators_get_v1_tiktok_video_comment_replies - First observed
scrapecreators_get_v1_tiktok_video_comments - First observed
scrapecreators_get_v1_truthsocial_post - First observed
scrapecreators_get_v1_truthsocial_profile - First observed
scrapecreators_get_v1_truthsocial_user_posts - First observed
scrapecreators_get_v1_twitch_clip - First observed
scrapecreators_get_v1_twitch_clip_transcript - First observed
scrapecreators_get_v1_twitch_profile - First observed
scrapecreators_get_v1_twitch_user_schedule - First observed
scrapecreators_get_v1_twitch_user_videos - First observed
scrapecreators_get_v1_twitter_community - First observed
scrapecreators_get_v1_twitter_community_tweets - First observed
scrapecreators_get_v1_twitter_profile - First observed
scrapecreators_get_v1_twitter_search_posts - First observed
scrapecreators_get_v1_twitter_tweet - First observed
scrapecreators_get_v1_twitter_user_tweets - First observed
scrapecreators_get_v1_youtube_channel - First observed
scrapecreators_get_v1_youtube_channel_community_posts - First observed
scrapecreators_get_v1_youtube_channel_lives - First observed
scrapecreators_get_v1_youtube_channel_playlists - First observed
scrapecreators_get_v1_youtube_channel_search - First observed
scrapecreators_get_v1_youtube_channel_shorts - First observed
scrapecreators_get_v1_youtube_channel_videos - First observed
scrapecreators_get_v1_youtube_community_post - First observed
scrapecreators_get_v1_youtube_playlist - First observed
scrapecreators_get_v1_youtube_search - First observed
scrapecreators_get_v1_youtube_search_hashtag - First observed
scrapecreators_get_v1_youtube_search_typeahead - First observed
scrapecreators_get_v1_youtube_shorts_trending - First observed
scrapecreators_get_v1_youtube_video - First observed
scrapecreators_get_v1_youtube_video_comment_replies - First observed
scrapecreators_get_v1_youtube_video_comments - First observed
scrapecreators_get_v1_youtube_video_sponsors - First observed
scrapecreators_get_v1_youtube_video_transcript - First observed
scrapecreators_get_v2_instagram_post_comments - First observed
scrapecreators_get_v2_instagram_reels_search - First observed
scrapecreators_get_v2_instagram_user_posts - First observed
scrapecreators_get_v2_tiktok_video - First observed
scrapecreators_get_v3_tiktok_profile_videos - First observed
scrapecreators_post_v1_facebook_adlibrary_company_ads - First observed
scrapecreators_post_v1_facebook_adlibrary_search_ads - First observed
scrapecreators_post_v1_reddit_post_comments - First observed
search1api_get_deepcrawl_status_taskid - First observed
search1api_get_usage - First observed
search1api_post_ask - First observed
search1api_post_extract - First observed
search1api_post_feedback - First observed
search1api_post_maps - First observed
search1api_post_sitemap - First observed
search1api_post_trending - First observed
serper_post - First observed
serper_post_autocomplete - First observed
serper_post_lens - First observed
serper_post_maps - First observed
serper_post_news - First observed
serper_post_patents - First observed
serper_post_places - First observed
serper_post_reviews - First observed
serper_post_scholar - First observed
serper_post_search - First observed
serper_post_shopping - First observed
serper_post_videos - First observed
sourcify_get_server_chains - First observed
sourcify_get_server_v2_contract_chainid_address - First observed
sourcify_get_server_v2_contracts_chainid - First observed
sourcify_get_signature_database_v1_lookup - First observed
sourcify_get_signature_database_v1_recent - First observed
sourcify_get_signature_database_v1_search - First observed
sourcify_get_signature_database_v1_stats - First observed
tavily_post_crawl - First observed
tavily_post_extract - First observed
tavily_post_map - First observed
tavily_post_search - First observed
tikhub_get_api_v1_bilibili_app_fetch_bangumi_tab - First observed
tikhub_get_api_v1_bilibili_app_fetch_cinema_tab - First observed
tikhub_get_api_v1_bilibili_app_fetch_home_feed - First observed
tikhub_get_api_v1_bilibili_app_fetch_one_video - First observed
tikhub_get_api_v1_bilibili_app_fetch_popular_feed - First observed
tikhub_get_api_v1_bilibili_app_fetch_reply_detail - First observed
tikhub_get_api_v1_bilibili_app_fetch_search_all - First observed
tikhub_get_api_v1_bilibili_app_fetch_search_by_type - First observed
tikhub_get_api_v1_bilibili_app_fetch_user_info - First observed
tikhub_get_api_v1_bilibili_app_fetch_user_videos - First observed
tikhub_get_api_v1_bilibili_app_fetch_video_comments - First observed
tikhub_get_api_v1_bilibili_huahuo_account_session_info - First observed
tikhub_get_api_v1_bilibili_huahuo_cooperate_experience_industry - First observed
tikhub_get_api_v1_bilibili_huahuo_dmp_pkg_list - First observed
tikhub_get_api_v1_bilibili_huahuo_effect_goods_drop - First observed
tikhub_get_api_v1_bilibili_huahuo_industry_tags - First observed
tikhub_get_api_v1_bilibili_huahuo_label_char_style - First observed
tikhub_get_api_v1_bilibili_huahuo_live_area_list - First observed
tikhub_get_api_v1_bilibili_huahuo_live_commerce_info - First observed
tikhub_get_api_v1_bilibili_huahuo_live_good_category - First observed
tikhub_get_api_v1_bilibili_huahuo_live_guild_drop - First observed
tikhub_get_api_v1_bilibili_huahuo_live_parent_tag - First observed
tikhub_get_api_v1_bilibili_huahuo_live_upper_portrait - First observed
tikhub_get_api_v1_bilibili_huahuo_mcn_drop - First observed
tikhub_get_api_v1_bilibili_huahuo_partition_drop - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_avid_category_drop - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_avid_list - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_goods_industry_up_list - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_goods_list - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_goods_up_list - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_up_list - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_up_tid_drop - First observed
tikhub_get_api_v1_bilibili_huahuo_popular_up_x_huo - First observed
tikhub_get_api_v1_bilibili_huahuo_region_drop - First observed
tikhub_get_api_v1_bilibili_huahuo_search_upper_suggest - First observed
tikhub_get_api_v1_bilibili_huahuo_square_static_info - First observed
tikhub_get_api_v1_bilibili_huahuo_tag_character - First observed
tikhub_get_api_v1_bilibili_huahuo_tag_commercial - First observed
tikhub_get_api_v1_bilibili_huahuo_tag_occupation - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_archive_highlights - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_base_info - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_busy_time - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_by_nickname - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_detail - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_draft_performance - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_draft_trend - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_fans_trend - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_label_tree - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_overlap_uppers - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_representative - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_seek_info - First observed
tikhub_get_api_v1_bilibili_huahuo_upper_similar - First observed
tikhub_get_api_v1_bilibili_huahuo_x_huo_date_options - First observed
tikhub_get_api_v1_bilibili_huahuo_x_huo_industry_drop - First observed
tikhub_get_api_v1_bilibili_web_bv_to_aid - First observed
tikhub_get_api_v1_bilibili_web_fetch_all_live_areas - First observed
tikhub_get_api_v1_bilibili_web_fetch_collect_folders - First observed
tikhub_get_api_v1_bilibili_web_fetch_com_popular - First observed
tikhub_get_api_v1_bilibili_web_fetch_comment_reply - First observed
tikhub_get_api_v1_bilibili_web_fetch_dynamic_detail - First observed
tikhub_get_api_v1_bilibili_web_fetch_dynamic_detail_v2 - First observed
tikhub_get_api_v1_bilibili_web_fetch_general_search - First observed
tikhub_get_api_v1_bilibili_web_fetch_get_user_id - First observed
tikhub_get_api_v1_bilibili_web_fetch_live_room_detail - First observed
tikhub_get_api_v1_bilibili_web_fetch_live_streamers - First observed
tikhub_get_api_v1_bilibili_web_fetch_live_videos - First observed
tikhub_get_api_v1_bilibili_web_fetch_one_video - First observed
tikhub_get_api_v1_bilibili_web_fetch_one_video_v2 - First observed
tikhub_get_api_v1_bilibili_web_fetch_one_video_v3 - First observed
tikhub_get_api_v1_bilibili_web_fetch_user_collection_videos - First observed
tikhub_get_api_v1_bilibili_web_fetch_user_dynamic - First observed
tikhub_get_api_v1_bilibili_web_fetch_user_post_videos - First observed
tikhub_get_api_v1_bilibili_web_fetch_user_post_videos_v2 - First observed
tikhub_get_api_v1_bilibili_web_fetch_user_profile - First observed
tikhub_get_api_v1_bilibili_web_fetch_user_relation_stat - First observed
tikhub_get_api_v1_bilibili_web_fetch_user_up_stat - First observed
tikhub_get_api_v1_bilibili_web_fetch_video_comments - First observed
tikhub_get_api_v1_bilibili_web_fetch_video_danmaku - First observed
tikhub_get_api_v1_bilibili_web_fetch_video_detail - First observed
tikhub_get_api_v1_bilibili_web_fetch_video_parts - First observed
tikhub_get_api_v1_bilibili_web_fetch_video_play_info - First observed
tikhub_get_api_v1_bilibili_web_fetch_video_playurl - First observed
tikhub_get_api_v1_bilibili_web_fetch_video_subtitle - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_brand_hot_search_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_brand_hot_search_list_deta - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_hashtag_detail - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_hashtag_video_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_hot_search_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_live_hot_search_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_multi_video_statistics - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_music_detail - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_music_hot_search_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_music_video_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_one_video - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_one_video_by_share_url - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_one_video_v2 - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_one_video_v3 - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_series_detail - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_series_video_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_share_info_by_share_code - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_user_fans_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_user_like_videos - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_user_post_videos - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_user_series_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_video_comment_replies - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_video_comments - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_video_high_quality_play_ur - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_video_mix_detail - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_video_mix_post_list - First observed
tikhub_get_api_v1_douyin_app_v3_fetch_video_statistics - First observed
tikhub_get_api_v1_douyin_app_v3_generate_douyin_short_url - First observed
tikhub_get_api_v1_douyin_app_v3_generate_douyin_video_share_qrco - First observed
tikhub_get_api_v1_douyin_app_v3_handler_user_profile - First observed
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_keyword_searc - First observed
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_send_private - First observed
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_user_profile - First observed
tikhub_get_api_v1_douyin_app_v3_open_douyin_app_to_video_detail - First observed
tikhub_get_api_v1_douyin_app_v3_register_device - First observed
tikhub_get_api_v1_douyin_billboard_fetch_city_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_content_tag - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_inte_2 - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_inte_3 - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_intere - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_fans_portra - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_item_analys - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_search_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_account_trends_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_calendar_detail - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_category_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_challenge_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_city_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_comment_word_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_item_trends_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_rise_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_total_hot_word_deta - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_total_list - First observed
tikhub_get_api_v1_douyin_billboard_fetch_hot_user_portrait_list - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_activity_detail - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_activity_list - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_content_category - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_content_course - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_challenge_bil - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_course - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_music_billboa - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_props_billboa - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_spot_billboar - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_hot_topic_billboa - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_material_center_b - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_material_center_c - First observed
tikhub_get_api_v1_douyin_creator_fetch_creator_material_center_r - First observed
tikhub_get_api_v1_douyin_creator_fetch_industry_category_config - First observed
tikhub_get_api_v1_douyin_creator_fetch_mission_task_list - First observed
tikhub_get_api_v1_douyin_creator_fetch_user_search - First observed
tikhub_get_api_v1_douyin_creator_fetch_video_danmaku_list - First observed
tikhub_get_api_v1_douyin_index_fetch_all_area - First observed
tikhub_get_api_v1_douyin_index_fetch_all_valid_date - First observed
tikhub_get_api_v1_douyin_index_fetch_content_publish_trend - First observed
tikhub_get_api_v1_douyin_index_fetch_content_valid_date - First observed
tikhub_get_api_v1_douyin_index_fetch_current_hot_topic - First observed
tikhub_get_api_v1_douyin_index_fetch_encrypt_user_id - First observed
tikhub_get_api_v1_douyin_index_fetch_hot_detail - First observed
tikhub_get_api_v1_douyin_index_fetch_hot_trend_word - First observed
tikhub_get_api_v1_douyin_index_fetch_hot_words - First observed
tikhub_get_api_v1_douyin_index_fetch_insight_get_rec - First observed
tikhub_get_api_v1_douyin_index_fetch_insight_recommend - First observed
tikhub_get_api_v1_douyin_index_fetch_item_filter_options - First observed
tikhub_get_api_v1_douyin_index_fetch_report_detail - First observed
tikhub_get_api_v1_douyin_index_fetch_valid_date_for_relation - First observed
tikhub_get_api_v1_douyin_web_encrypt_uid_to_sec_user_id - First observed
tikhub_get_api_v1_douyin_web_fetch_batch_user_profile_v1 - First observed
tikhub_get_api_v1_douyin_web_fetch_batch_user_profile_v2 - First observed
tikhub_get_api_v1_douyin_web_fetch_cartoon_aweme - First observed
tikhub_get_api_v1_douyin_web_fetch_douyin_web_guest_cookie - First observed
tikhub_get_api_v1_douyin_web_fetch_food_aweme - First observed
tikhub_get_api_v1_douyin_web_fetch_game_aweme - First observed
tikhub_get_api_v1_douyin_web_fetch_hot_search_result - First observed
tikhub_get_api_v1_douyin_web_fetch_knowledge_aweme - First observed
tikhub_get_api_v1_douyin_web_fetch_live_gift_ranking - First observed
tikhub_get_api_v1_douyin_web_fetch_live_im_fetch - First observed
tikhub_get_api_v1_douyin_web_fetch_music_aweme - First observed
tikhub_get_api_v1_douyin_web_fetch_one_video - First observed
tikhub_get_api_v1_douyin_web_fetch_one_video_by_share_url - First observed
tikhub_get_api_v1_douyin_web_fetch_one_video_danmaku - First observed
tikhub_get_api_v1_douyin_web_fetch_one_video_v2 - First observed
tikhub_get_api_v1_douyin_web_fetch_related_posts - First observed
tikhub_get_api_v1_douyin_web_fetch_series_aweme - First observed
tikhub_get_api_v1_douyin_web_fetch_user_collects_videos - First observed
tikhub_get_api_v1_douyin_web_fetch_user_fans_list - First observed
tikhub_get_api_v1_douyin_web_fetch_user_following_list - First observed
tikhub_get_api_v1_douyin_web_fetch_user_live_info_by_uid - First observed
tikhub_get_api_v1_douyin_web_fetch_user_live_videos - First observed
tikhub_get_api_v1_douyin_web_fetch_user_live_videos_by_room_id_v - First observed
tikhub_get_api_v1_douyin_web_fetch_user_live_videos_by_sec_uid - First observed
tikhub_get_api_v1_douyin_web_fetch_user_mix_videos - First observed
tikhub_get_api_v1_douyin_web_fetch_user_post_videos - First observed
tikhub_get_api_v1_douyin_web_fetch_user_profile_by_short_id - First observed
tikhub_get_api_v1_douyin_web_fetch_user_profile_by_uid - First observed
tikhub_get_api_v1_douyin_web_fetch_video_channel_result - First observed
tikhub_get_api_v1_douyin_web_fetch_video_comment_replies - First observed
tikhub_get_api_v1_douyin_web_fetch_video_comments - First observed
tikhub_get_api_v1_douyin_web_fetch_video_high_quality_play_url - First observed
tikhub_get_api_v1_douyin_web_generate_ttwid - First observed
tikhub_get_api_v1_douyin_web_generate_wss_xb_signature - First observed
tikhub_get_api_v1_douyin_web_get_aweme_id - First observed
tikhub_get_api_v1_douyin_web_get_sec_user_id - First observed
tikhub_get_api_v1_douyin_web_get_webcast_id - First observed
tikhub_get_api_v1_douyin_web_handler_shorten_url - First observed
tikhub_get_api_v1_douyin_web_handler_user_profile - First observed
tikhub_get_api_v1_douyin_web_handler_user_profile_v2 - First observed
tikhub_get_api_v1_douyin_web_handler_user_profile_v3 - First observed
tikhub_get_api_v1_douyin_web_handler_user_profile_v4 - First observed
tikhub_get_api_v1_douyin_web_webcast_id_2_room_id - First observed
tikhub_get_api_v1_douyin_xingtu_author_content_hot_comment_keywo - First observed
tikhub_get_api_v1_douyin_xingtu_author_homepage_videos_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_author_hot_comment_tokens_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_get_sign_image - First observed
tikhub_get_api_v1_douyin_xingtu_get_xingtu_kolid_by_sec_user_id - First observed
tikhub_get_api_v1_douyin_xingtu_get_xingtu_kolid_by_uid - First observed
tikhub_get_api_v1_douyin_xingtu_get_xingtu_kolid_by_unique_id - First observed
tikhub_get_api_v1_douyin_xingtu_kol_audience_portrait_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_base_info_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_conversion_ability_analysis - First observed
tikhub_get_api_v1_douyin_xingtu_kol_convert_video_display_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_cp_info_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_daily_fans_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_data_overview_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_fans_portrait_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_link_struct_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_rec_videos_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_service_price_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_touch_distribution_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_video_performance_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_kol_xingtu_index_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_search_kol_v1 - First observed
tikhub_get_api_v1_douyin_xingtu_search_kol_v2 - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_audience_distribut - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_base_info - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_business_card_info - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_commerce_spread_in - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_content_hot_keywor - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_convert_ability - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_convert_videos_or - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_cp_info - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_daily_fans - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_daily_link - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_daily_link_score - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_fans_distribution - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_homepage_videos - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_hot_comment_tokens - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_link_info - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_local_info - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_market_fields - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_rec_videos_v2 - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_show_items - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_spread_info - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_spread_videos - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_touch_distribution - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_author_video_distribution - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_content_trend_guide - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_demander_mcn_list - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_excellent_case_category_l - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_ip_activity_detail - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_ip_activity_industry_list - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_item_play_count - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_playlet_actor_rank_list - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_ranking_list_catalog - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_ranking_list_data - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_resource_list - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_search_field_options - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_user_profile_qrcode - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_xingtu_kolid_by_sec_user - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_xingtu_kolid_by_uid - First observed
tikhub_get_api_v1_douyin_xingtu_v2_get_xingtu_kolid_by_unique_id - First observed
tikhub_get_api_v1_douyin_xingtu_v2_search_anchor - First observed
tikhub_get_api_v1_douyin_xingtu_v2_search_creator - First observed
tikhub_get_api_v1_douyin_xingtu_v2_search_toutiao_creator - First observed
tikhub_get_api_v1_hybrid_video_data - First observed
tikhub_get_api_v1_instagram_v1_fetch_cities - First observed
tikhub_get_api_v1_instagram_v1_fetch_comment_replies - First observed
tikhub_get_api_v1_instagram_v1_fetch_explore_sections - First observed
tikhub_get_api_v1_instagram_v1_fetch_hashtag_posts - First observed
tikhub_get_api_v1_instagram_v1_fetch_location_info - First observed
tikhub_get_api_v1_instagram_v1_fetch_location_posts - First observed
tikhub_get_api_v1_instagram_v1_fetch_locations - First observed
tikhub_get_api_v1_instagram_v1_fetch_music_posts - First observed
tikhub_get_api_v1_instagram_v1_fetch_post_by_id - First observed
tikhub_get_api_v1_instagram_v1_fetch_post_by_url - First observed
tikhub_get_api_v1_instagram_v1_fetch_post_by_url_v2 - First observed
tikhub_get_api_v1_instagram_v1_fetch_post_comments_v2 - First observed
tikhub_get_api_v1_instagram_v1_fetch_related_profiles - First observed
tikhub_get_api_v1_instagram_v1_fetch_search - First observed
tikhub_get_api_v1_instagram_v1_fetch_section_posts - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_about_info - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_id - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_id_v2 - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_username - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_username_v2 - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_info_by_username_v3 - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_posts - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_posts_v2 - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_reels - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_reposts - First observed
tikhub_get_api_v1_instagram_v1_fetch_user_tagged_posts - First observed
tikhub_get_api_v1_instagram_v1_media_id_to_shortcode - First observed
tikhub_get_api_v1_instagram_v1_shortcode_to_media_id - First observed
tikhub_get_api_v1_instagram_v1_user_id_to_username - First observed
tikhub_get_api_v1_instagram_v2_fetch_comment_replies - First observed
tikhub_get_api_v1_instagram_v2_fetch_hashtag_posts - First observed
tikhub_get_api_v1_instagram_v2_fetch_highlight_stories - First observed
tikhub_get_api_v1_instagram_v2_fetch_location_posts - First observed
tikhub_get_api_v1_instagram_v2_fetch_music_posts - First observed
tikhub_get_api_v1_instagram_v2_fetch_post_comments - First observed
tikhub_get_api_v1_instagram_v2_fetch_post_info - First observed
tikhub_get_api_v1_instagram_v2_fetch_post_likes - First observed
tikhub_get_api_v1_instagram_v2_fetch_similar_users - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_followers - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_following - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_highlights - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_info - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_posts - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_reels - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_stories - First observed
tikhub_get_api_v1_instagram_v2_fetch_user_tagged_posts - First observed
tikhub_get_api_v1_instagram_v2_general_search - First observed
tikhub_get_api_v1_instagram_v2_media_id_to_shortcode - First observed
tikhub_get_api_v1_instagram_v2_search_by_coordinates - First observed
tikhub_get_api_v1_instagram_v2_search_hashtags - First observed
tikhub_get_api_v1_instagram_v2_search_locations - First observed
tikhub_get_api_v1_instagram_v2_search_music - First observed
tikhub_get_api_v1_instagram_v2_search_reels - First observed
tikhub_get_api_v1_instagram_v2_search_users - First observed
tikhub_get_api_v1_instagram_v2_shortcode_to_media_id - First observed
tikhub_get_api_v1_instagram_v2_user_id_to_username - First observed
tikhub_get_api_v1_instagram_v3_bulk_translate_comments - First observed
tikhub_get_api_v1_instagram_v3_extract_shortcode - First observed
tikhub_get_api_v1_instagram_v3_general_search - First observed
tikhub_get_api_v1_instagram_v3_get_comment_replies - First observed
tikhub_get_api_v1_instagram_v3_get_explore - First observed
tikhub_get_api_v1_instagram_v3_get_hashtag_posts - First observed
tikhub_get_api_v1_instagram_v3_get_highlight_stories - First observed
tikhub_get_api_v1_instagram_v3_get_location_info - First observed
tikhub_get_api_v1_instagram_v3_get_location_nearby - First observed
tikhub_get_api_v1_instagram_v3_get_location_posts - First observed
tikhub_get_api_v1_instagram_v3_get_music_posts - First observed
tikhub_get_api_v1_instagram_v3_get_post_comments - First observed
tikhub_get_api_v1_instagram_v3_get_post_info - First observed
tikhub_get_api_v1_instagram_v3_get_post_info_by_code - First observed
tikhub_get_api_v1_instagram_v3_get_post_likes - First observed
tikhub_get_api_v1_instagram_v3_get_post_oembed - First observed
tikhub_get_api_v1_instagram_v3_get_recommended_reels - First observed
tikhub_get_api_v1_instagram_v3_get_similar_users - First observed
tikhub_get_api_v1_instagram_v3_get_user_about - First observed
tikhub_get_api_v1_instagram_v3_get_user_brief - First observed
tikhub_get_api_v1_instagram_v3_get_user_followers - First observed
tikhub_get_api_v1_instagram_v3_get_user_following - First observed
tikhub_get_api_v1_instagram_v3_get_user_former_usernames - First observed
tikhub_get_api_v1_instagram_v3_get_user_highlights - First observed
tikhub_get_api_v1_instagram_v3_get_user_id_by_username - First observed
tikhub_get_api_v1_instagram_v3_get_user_posts - First observed
tikhub_get_api_v1_instagram_v3_get_user_profile - First observed
tikhub_get_api_v1_instagram_v3_get_user_reels - First observed
tikhub_get_api_v1_instagram_v3_get_user_stories - First observed
tikhub_get_api_v1_instagram_v3_get_user_tagged_posts - First observed
tikhub_get_api_v1_instagram_v3_media_id_to_shortcode - First observed
tikhub_get_api_v1_instagram_v3_search_by_coordinates - First observed
tikhub_get_api_v1_instagram_v3_search_hashtags - First observed
tikhub_get_api_v1_instagram_v3_search_users - First observed
tikhub_get_api_v1_instagram_v3_shortcode_to_media_id - First observed
tikhub_get_api_v1_instagram_v3_translate_comment - First observed
tikhub_get_api_v1_instagram_v3_user_id_to_username - First observed
tikhub_get_api_v1_kuaishou_app_fetch_brand_top_list - First observed
tikhub_get_api_v1_kuaishou_app_fetch_hot_board_categories - First observed
tikhub_get_api_v1_kuaishou_app_fetch_hot_board_detail - First observed
tikhub_get_api_v1_kuaishou_app_fetch_hot_search_person - First observed
tikhub_get_api_v1_kuaishou_app_fetch_live_top_list - First observed
tikhub_get_api_v1_kuaishou_app_fetch_music_ranking - First observed
tikhub_get_api_v1_kuaishou_app_fetch_one_user_v2 - First observed
tikhub_get_api_v1_kuaishou_app_fetch_one_video - First observed
tikhub_get_api_v1_kuaishou_app_fetch_one_video_by_url - First observed
tikhub_get_api_v1_kuaishou_app_fetch_selection_feed - First observed
tikhub_get_api_v1_kuaishou_app_fetch_shopping_top_list - First observed
tikhub_get_api_v1_kuaishou_app_fetch_tag_feed - First observed
tikhub_get_api_v1_kuaishou_app_fetch_user_hot_post - First observed
tikhub_get_api_v1_kuaishou_app_fetch_user_live_info - First observed
tikhub_get_api_v1_kuaishou_app_fetch_user_post_v2 - First observed
tikhub_get_api_v1_kuaishou_app_fetch_video_comment - First observed
tikhub_get_api_v1_kuaishou_app_fetch_video_sub_comments - First observed
tikhub_get_api_v1_kuaishou_app_fetch_videos_batch - First observed
tikhub_get_api_v1_kuaishou_app_generate_kuaishou_share_link - First observed
tikhub_get_api_v1_kuaishou_app_search_comprehensive - First observed
tikhub_get_api_v1_kuaishou_app_search_image - First observed
tikhub_get_api_v1_kuaishou_app_search_live - First observed
tikhub_get_api_v1_kuaishou_app_search_music - First observed
tikhub_get_api_v1_kuaishou_app_search_tag - First observed
tikhub_get_api_v1_kuaishou_app_search_user_v2 - First observed
tikhub_get_api_v1_kuaishou_app_search_video_v2 - First observed
tikhub_get_api_v1_kuaishou_web_fetch_get_user_id - First observed
tikhub_get_api_v1_kuaishou_web_fetch_kuaishou_hot_list_v1 - First observed
tikhub_get_api_v1_kuaishou_web_fetch_kuaishou_hot_list_v2 - First observed
tikhub_get_api_v1_kuaishou_web_fetch_one_video - First observed
tikhub_get_api_v1_kuaishou_web_fetch_one_video_by_url - First observed
tikhub_get_api_v1_kuaishou_web_fetch_one_video_comment - First observed
tikhub_get_api_v1_kuaishou_web_fetch_one_video_sub_comment - First observed
tikhub_get_api_v1_kuaishou_web_fetch_one_video_v2 - First observed
tikhub_get_api_v1_kuaishou_web_fetch_user_collect - First observed
tikhub_get_api_v1_kuaishou_web_fetch_user_info - First observed
tikhub_get_api_v1_kuaishou_web_fetch_user_live_replay - First observed
tikhub_get_api_v1_kuaishou_web_generate_share_short_url - First observed
tikhub_get_api_v1_lemon8_app_fetch_discover_banners - First observed
tikhub_get_api_v1_lemon8_app_fetch_discover_tab - First observed
tikhub_get_api_v1_lemon8_app_fetch_discover_tab_information_tabs - First observed
tikhub_get_api_v1_lemon8_app_fetch_hot_search_keywords - First observed
tikhub_get_api_v1_lemon8_app_fetch_post_comment_list - First observed
tikhub_get_api_v1_lemon8_app_fetch_post_detail - First observed
tikhub_get_api_v1_lemon8_app_fetch_search - First observed
tikhub_get_api_v1_lemon8_app_fetch_topic_info - First observed
tikhub_get_api_v1_lemon8_app_fetch_topic_post_list - First observed
tikhub_get_api_v1_lemon8_app_fetch_user_follower_list - First observed
tikhub_get_api_v1_lemon8_app_fetch_user_following_list - First observed
tikhub_get_api_v1_lemon8_app_fetch_user_profile - First observed
tikhub_get_api_v1_lemon8_app_get_item_id - First observed
tikhub_get_api_v1_lemon8_app_get_user_id - First observed
tikhub_get_api_v1_linkedin_web_v2_get_company_posts - First observed
tikhub_get_api_v1_linkedin_web_v2_get_company_profile - First observed
tikhub_get_api_v1_linkedin_web_v2_get_job_detail - First observed
tikhub_get_api_v1_linkedin_web_v2_get_post_comments - First observed
tikhub_get_api_v1_linkedin_web_v2_get_post_detail - First observed
tikhub_get_api_v1_linkedin_web_v2_get_user_posts - First observed
tikhub_get_api_v1_linkedin_web_v2_get_user_profile - First observed
tikhub_get_api_v1_linkedin_web_v2_search_jobs - First observed
tikhub_get_api_v1_pipixia_app_fetch_hashtag_detail - First observed
tikhub_get_api_v1_pipixia_app_fetch_hashtag_post_list - First observed
tikhub_get_api_v1_pipixia_app_fetch_home_feed - First observed
tikhub_get_api_v1_pipixia_app_fetch_home_short_drama_feed - First observed
tikhub_get_api_v1_pipixia_app_fetch_hot_search_board_detail - First observed
tikhub_get_api_v1_pipixia_app_fetch_hot_search_board_list - First observed
tikhub_get_api_v1_pipixia_app_fetch_hot_search_words - First observed
tikhub_get_api_v1_pipixia_app_fetch_increase_post_view_count - First observed
tikhub_get_api_v1_pipixia_app_fetch_post_comment_list - First observed
tikhub_get_api_v1_pipixia_app_fetch_post_detail - First observed
tikhub_get_api_v1_pipixia_app_fetch_post_statistics - First observed
tikhub_get_api_v1_pipixia_app_fetch_search - First observed
tikhub_get_api_v1_pipixia_app_fetch_short_url - First observed
tikhub_get_api_v1_pipixia_app_fetch_user_follower_list - First observed
tikhub_get_api_v1_pipixia_app_fetch_user_following_list - First observed
tikhub_get_api_v1_pipixia_app_fetch_user_info - First observed
tikhub_get_api_v1_pipixia_app_fetch_user_post_list - First observed
tikhub_get_api_v1_reddit_app_check_subreddit_muted - First observed
tikhub_get_api_v1_reddit_app_fetch_comment_replies - First observed
tikhub_get_api_v1_reddit_app_fetch_community_highlights - First observed
tikhub_get_api_v1_reddit_app_fetch_dynamic_search - First observed
tikhub_get_api_v1_reddit_app_fetch_games_feed - First observed
tikhub_get_api_v1_reddit_app_fetch_home_feed - First observed
tikhub_get_api_v1_reddit_app_fetch_news_feed - First observed
tikhub_get_api_v1_reddit_app_fetch_popular_feed - First observed
tikhub_get_api_v1_reddit_app_fetch_post_comments - First observed
tikhub_get_api_v1_reddit_app_fetch_post_details - First observed
tikhub_get_api_v1_reddit_app_fetch_post_details_batch - First observed
tikhub_get_api_v1_reddit_app_fetch_post_details_batch_large - First observed
tikhub_get_api_v1_reddit_app_fetch_search_typeahead - First observed
tikhub_get_api_v1_reddit_app_fetch_subreddit_feed - First observed
tikhub_get_api_v1_reddit_app_fetch_subreddit_info - First observed
tikhub_get_api_v1_reddit_app_fetch_subreddit_post_channels - First observed
tikhub_get_api_v1_reddit_app_fetch_subreddit_settings - First observed
tikhub_get_api_v1_reddit_app_fetch_subreddit_style - First observed
tikhub_get_api_v1_reddit_app_fetch_trending_searches - First observed
tikhub_get_api_v1_reddit_app_fetch_user_active_subreddits - First observed
tikhub_get_api_v1_reddit_app_fetch_user_comments - First observed
tikhub_get_api_v1_reddit_app_fetch_user_posts - First observed
tikhub_get_api_v1_reddit_app_fetch_user_profile - First observed
tikhub_get_api_v1_reddit_app_fetch_user_trophies - First observed
tikhub_get_api_v1_telegram_web_batch_channel_info - First observed
tikhub_get_api_v1_telegram_web_fetch_channel_info - First observed
tikhub_get_api_v1_telegram_web_fetch_channel_posts - First observed
tikhub_get_api_v1_telegram_web_fetch_channel_search - First observed
tikhub_get_api_v1_telegram_web_fetch_post_comments - First observed
tikhub_get_api_v1_telegram_web_fetch_post_detail - First observed
tikhub_get_api_v1_telegram_web_fetch_similar_channels - First observed
tikhub_get_api_v1_threads_web_fetch_post_comments - First observed
tikhub_get_api_v1_threads_web_fetch_post_detail - First observed
tikhub_get_api_v1_threads_web_fetch_post_detail_v2 - First observed
tikhub_get_api_v1_threads_web_fetch_user_info - First observed
tikhub_get_api_v1_threads_web_fetch_user_info_by_id - First observed
tikhub_get_api_v1_threads_web_fetch_user_posts - First observed
tikhub_get_api_v1_threads_web_fetch_user_replies - First observed
tikhub_get_api_v1_threads_web_fetch_user_reposts - First observed
tikhub_get_api_v1_threads_web_search_posts - First observed
tikhub_get_api_v1_threads_web_search_profiles - First observed
tikhub_get_api_v1_threads_web_search_recent - First observed
tikhub_get_api_v1_threads_web_search_top - First observed
tikhub_get_api_v1_tiktok_analytics_detect_fake_views - First observed
tikhub_get_api_v1_tiktok_analytics_fetch_comment_keywords - First observed
tikhub_get_api_v1_tiktok_analytics_fetch_creator_info_and_milest - First observed
tikhub_get_api_v1_tiktok_analytics_fetch_video_metrics - First observed
tikhub_get_api_v1_tiktok_app_v3_check_live_room_online - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_info - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insights - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insights_de - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insights_tr - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_creator_search_insights_vi - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_general_search_result - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_hashtag_detail - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_hashtag_search_result - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_hashtag_video_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_live_daily_rank - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_live_ranking_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_live_room_info - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_live_room_product_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_live_room_product_list_v2 - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_live_search_result - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_location_search - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_music_chart_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_music_detail - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_music_search_result - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_music_video_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_one_video - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_one_video_by_share_url - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_one_video_by_share_url_v2 - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_one_video_v2 - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_one_video_v3 - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_share_qr_code - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_share_short_link - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_similar_user_recommendatio - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_country_by_username - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_follower_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_following_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_like_videos - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_music_list - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_post_videos - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_post_videos_v2 - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_post_videos_v3 - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_repost_videos - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_user_search_result - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_video_comment_replies - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_video_comments - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_video_search_result - First observed
tikhub_get_api_v1_tiktok_app_v3_fetch_webcast_user_info - First observed
tikhub_get_api_v1_tiktok_app_v3_get_user_id_and_sec_user_id_by_u - First observed
tikhub_get_api_v1_tiktok_app_v3_handler_user_profile - First observed
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_keyword_searc - First observed
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_send_private - First observed
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_user_profile - First observed
tikhub_get_api_v1_tiktok_app_v3_open_tiktok_app_to_video_detail - First observed
tikhub_get_api_v1_tiktok_app_v3_search_follower_list - First observed
tikhub_get_api_v1_tiktok_app_v3_search_following_list - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_hot_selling_products_lis - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_product_detail - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_product_detail_v2 - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_product_detail_v3 - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_product_id_by_share_link - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_product_reviews_v2 - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_products_by_category_id - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_products_category_list - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_search_products_list - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_search_products_list_v2 - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_search_word_suggestion_v - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_seller_products_list - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_seller_products_list_v2 - First observed
tikhub_get_api_v1_tiktok_shop_web_fetch_shop_id_by_share_link - First observed
tikhub_get_api_v1_tiktok_web_decrypt_strdata - First observed
tikhub_get_api_v1_tiktok_web_device_register - First observed
tikhub_get_api_v1_tiktok_web_encrypt_strdata - First observed
tikhub_get_api_v1_tiktok_web_fetch_batch_check_live_alive - First observed
tikhub_get_api_v1_tiktok_web_fetch_check_live_alive - First observed
tikhub_get_api_v1_tiktok_web_fetch_explore_post - First observed
tikhub_get_api_v1_tiktok_web_fetch_general_search - First observed
tikhub_get_api_v1_tiktok_web_fetch_live_gift_list - First observed
tikhub_get_api_v1_tiktok_web_fetch_live_im_fetch - First observed
tikhub_get_api_v1_tiktok_web_fetch_live_recommend - First observed
tikhub_get_api_v1_tiktok_web_fetch_live_recommend_tabs - First observed
tikhub_get_api_v1_tiktok_web_fetch_post_ai_article - First observed
tikhub_get_api_v1_tiktok_web_fetch_post_comment - First observed
tikhub_get_api_v1_tiktok_web_fetch_post_comment_reply - First observed
tikhub_get_api_v1_tiktok_web_fetch_post_detail - First observed
tikhub_get_api_v1_tiktok_web_fetch_post_detail_v2 - First observed
tikhub_get_api_v1_tiktok_web_fetch_search_keyword_suggest - First observed
tikhub_get_api_v1_tiktok_web_fetch_search_live - First observed
tikhub_get_api_v1_tiktok_web_fetch_search_photo - First observed
tikhub_get_api_v1_tiktok_web_fetch_search_user - First observed
tikhub_get_api_v1_tiktok_web_fetch_search_video - First observed
tikhub_get_api_v1_tiktok_web_fetch_tag_detail - First observed
tikhub_get_api_v1_tiktok_web_fetch_tag_post - First observed
tikhub_get_api_v1_tiktok_web_fetch_tiktok_live_data - First observed
tikhub_get_api_v1_tiktok_web_fetch_tiktok_web_guest_cookie - First observed
tikhub_get_api_v1_tiktok_web_fetch_trending_searchwords - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_collect - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_fans - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_follow - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_like - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_live_detail - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_mix - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_play_list - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_post - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_profile - First observed
tikhub_get_api_v1_tiktok_web_fetch_user_repost - First observed
tikhub_get_api_v1_tiktok_web_generate_fingerprint - First observed
tikhub_get_api_v1_tiktok_web_generate_hashed_id - First observed
tikhub_get_api_v1_tiktok_web_generate_real_mstoken - First observed
tikhub_get_api_v1_tiktok_web_generate_ttwid - First observed
tikhub_get_api_v1_tiktok_web_generate_webid - First observed
tikhub_get_api_v1_tiktok_web_get_aweme_id - First observed
tikhub_get_api_v1_tiktok_web_get_live_room_id - First observed
tikhub_get_api_v1_tiktok_web_get_sec_user_id - First observed
tikhub_get_api_v1_tiktok_web_get_unique_id - First observed
tikhub_get_api_v1_tiktok_web_get_user_id - First observed
tikhub_get_api_v1_tiktok_web_tiktok_live_room - First observed
tikhub_get_api_v1_toutiao_app_get_article_info - First observed
tikhub_get_api_v1_toutiao_app_get_comments - First observed
tikhub_get_api_v1_toutiao_app_get_user_id - First observed
tikhub_get_api_v1_toutiao_app_get_user_info - First observed
tikhub_get_api_v1_toutiao_app_get_video_info - First observed
tikhub_get_api_v1_toutiao_web_get_article_info - First observed
tikhub_get_api_v1_toutiao_web_get_video_info - First observed
tikhub_get_api_v1_twitter_web_fetch_latest_post_comments - First observed
tikhub_get_api_v1_twitter_web_fetch_post_comments - First observed
tikhub_get_api_v1_twitter_web_fetch_retweet_user_list - First observed
tikhub_get_api_v1_twitter_web_fetch_search_timeline - First observed
tikhub_get_api_v1_twitter_web_fetch_trending - First observed
tikhub_get_api_v1_twitter_web_fetch_tweet_detail - First observed
tikhub_get_api_v1_twitter_web_fetch_user_followers - First observed
tikhub_get_api_v1_twitter_web_fetch_user_followings - First observed
tikhub_get_api_v1_twitter_web_fetch_user_media - First observed
tikhub_get_api_v1_twitter_web_fetch_user_post_tweet - First observed
tikhub_get_api_v1_twitter_web_fetch_user_profile - First observed
tikhub_get_api_v1_twitter_web_fetch_user_tweet_replies - First observed
tikhub_get_api_v1_weibo_app_fetch_ai_smart_search - First observed
tikhub_get_api_v1_weibo_app_fetch_home_recommend_feed - First observed
tikhub_get_api_v1_weibo_app_fetch_hot_search - First observed
tikhub_get_api_v1_weibo_app_fetch_hot_search_brief - First observed
tikhub_get_api_v1_weibo_app_fetch_hot_search_categories - First observed
tikhub_get_api_v1_weibo_app_fetch_search_all - First observed
tikhub_get_api_v1_weibo_app_fetch_status_comments - First observed
tikhub_get_api_v1_weibo_app_fetch_status_detail - First observed
tikhub_get_api_v1_weibo_app_fetch_status_likes - First observed
tikhub_get_api_v1_weibo_app_fetch_status_reposts - First observed
tikhub_get_api_v1_weibo_app_fetch_user_album - First observed
tikhub_get_api_v1_weibo_app_fetch_user_articles - First observed
tikhub_get_api_v1_weibo_app_fetch_user_audios - First observed
tikhub_get_api_v1_weibo_app_fetch_user_followers - First observed
tikhub_get_api_v1_weibo_app_fetch_user_following - First observed
tikhub_get_api_v1_weibo_app_fetch_user_info - First observed
tikhub_get_api_v1_weibo_app_fetch_user_info_detail - First observed
tikhub_get_api_v1_weibo_app_fetch_user_profile_feed - First observed
tikhub_get_api_v1_weibo_app_fetch_user_super_topics - First observed
tikhub_get_api_v1_weibo_app_fetch_user_timeline - First observed
tikhub_get_api_v1_weibo_app_fetch_user_videos - First observed
tikhub_get_api_v1_weibo_app_fetch_video_detail - First observed
tikhub_get_api_v1_weibo_app_fetch_video_featured_feed - First observed
tikhub_get_api_v1_weibo_web_v2_check_allow_comment_with_pic - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_advanced_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_ai_related_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_ai_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_all_groups - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_city_list - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_entertainment_ranking - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_hot_ranking_timeline - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_hot_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_hot_search_index - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_hot_search_summary - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_life_ranking - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_pic_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_post_comments - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_post_detail - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_post_sub_comments - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_realtime_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_similar_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_social_ranking - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_topic_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_basic_info - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_fans - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_following - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_info - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_original_posts - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_posts - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_recommend_timeline - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_search - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_video_collection_detai - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_video_collection_list - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_user_video_list - First observed
tikhub_get_api_v1_weibo_web_v2_fetch_video_search - First observed
tikhub_get_api_v1_weibo_web_v2_search_user_posts - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_creator_hot_inspiration - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_creator_inspiration_fee - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_image_note_detail - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_note_comments - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_note_sub_comments - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_detail - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_recommendations - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_review_overview - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_product_reviews - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_topic_feed - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_topic_info - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_user_faved_notes - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_user_info - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_user_posted_notes - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_get_video_note_detail - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_search_groups - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_search_images - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_search_notes - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_search_products - First observed
tikhub_get_api_v1_xiaohongshu_app_v2_search_users - First observed
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_homefeed - First observed
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_homefeed_categories - First observed
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_note_detail - First observed
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_search_suggest - First observed
tikhub_get_api_v1_xiaohongshu_web_v3_fetch_user_info - First observed
tikhub_get_api_v1_xigua_app_v2_fetch_one_video - First observed
tikhub_get_api_v1_xigua_app_v2_fetch_one_video_play_url - First observed
tikhub_get_api_v1_xigua_app_v2_fetch_one_video_v2 - First observed
tikhub_get_api_v1_xigua_app_v2_fetch_user_info - First observed
tikhub_get_api_v1_xigua_app_v2_fetch_user_post_list - First observed
tikhub_get_api_v1_xigua_app_v2_fetch_video_comment_list - First observed
tikhub_get_api_v1_xigua_app_v2_search_video - First observed
tikhub_get_api_v1_youtube_web_get_channel_id - First observed
tikhub_get_api_v1_youtube_web_get_channel_id_v2 - First observed
tikhub_get_api_v1_youtube_web_get_channel_info - First observed
tikhub_get_api_v1_youtube_web_get_channel_short_videos - First observed
tikhub_get_api_v1_youtube_web_get_channel_url - First observed
tikhub_get_api_v1_youtube_web_get_relate_video - First observed
tikhub_get_api_v1_youtube_web_search_channel - First observed
tikhub_get_api_v1_youtube_web_search_video - First observed
tikhub_get_api_v1_youtube_web_v2_get_channel_community_posts - First observed
tikhub_get_api_v1_youtube_web_v2_get_channel_description - First observed
tikhub_get_api_v1_youtube_web_v2_get_channel_id - First observed
tikhub_get_api_v1_youtube_web_v2_get_channel_shorts - First observed
tikhub_get_api_v1_youtube_web_v2_get_channel_url - First observed
tikhub_get_api_v1_youtube_web_v2_get_channel_videos - First observed
tikhub_get_api_v1_youtube_web_v2_get_general_search - First observed
tikhub_get_api_v1_youtube_web_v2_get_general_search_v2 - First observed
tikhub_get_api_v1_youtube_web_v2_get_post_comment_replies - First observed
tikhub_get_api_v1_youtube_web_v2_get_post_comments - First observed
tikhub_get_api_v1_youtube_web_v2_get_post_detail - First observed
tikhub_get_api_v1_youtube_web_v2_get_related_videos - First observed
tikhub_get_api_v1_youtube_web_v2_get_search_suggestions - First observed
tikhub_get_api_v1_youtube_web_v2_get_shorts_search - First observed
tikhub_get_api_v1_youtube_web_v2_get_shorts_search_v2 - First observed
tikhub_get_api_v1_youtube_web_v2_get_signed_stream_url - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_captions - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_captions_result - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_comment_replies - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_comments - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_info - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_info_v2 - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_streams - First observed
tikhub_get_api_v1_youtube_web_v2_get_video_streams_v2 - First observed
tikhub_get_api_v1_youtube_web_v2_search_channels - First observed
tikhub_get_api_v1_zhihu_web_fetch_ai_search_stream - First observed
tikhub_get_api_v1_zhihu_web_fetch_answer_detail - First observed
tikhub_get_api_v1_zhihu_web_fetch_article_search_v3 - First observed
tikhub_get_api_v1_zhihu_web_fetch_column_article_detail - First observed
tikhub_get_api_v1_zhihu_web_fetch_column_articles - First observed
tikhub_get_api_v1_zhihu_web_fetch_column_comment_config - First observed
tikhub_get_api_v1_zhihu_web_fetch_column_recommend - First observed
tikhub_get_api_v1_zhihu_web_fetch_column_relationship - First observed
tikhub_get_api_v1_zhihu_web_fetch_column_search_v3 - First observed
tikhub_get_api_v1_zhihu_web_fetch_comment_v5 - First observed
tikhub_get_api_v1_zhihu_web_fetch_ebook_search_v3 - First observed
tikhub_get_api_v1_zhihu_web_fetch_hot_list - First observed
tikhub_get_api_v1_zhihu_web_fetch_hot_recommend - First observed
tikhub_get_api_v1_zhihu_web_fetch_pin_comments - First observed
tikhub_get_api_v1_zhihu_web_fetch_pin_detail - First observed
tikhub_get_api_v1_zhihu_web_fetch_preset_search - First observed
tikhub_get_api_v1_zhihu_web_fetch_question_answers - First observed
tikhub_get_api_v1_zhihu_web_fetch_question_detail - First observed
tikhub_get_api_v1_zhihu_web_fetch_recommend_followees - First observed
tikhub_get_api_v1_zhihu_web_fetch_salt_search_v3 - First observed
tikhub_get_api_v1_zhihu_web_fetch_search_recommend - First observed
tikhub_get_api_v1_zhihu_web_fetch_search_suggest - First observed
tikhub_get_api_v1_zhihu_web_fetch_sub_comment_v5 - First observed
tikhub_get_api_v1_zhihu_web_fetch_topic_search_v3 - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_answers - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_articles - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_collections - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_follow_collections - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_follow_columns - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_follow_questions - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_follow_topics - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_followees - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_followers - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_included_articles - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_info - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_pins - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_search_v3 - First observed
tikhub_get_api_v1_zhihu_web_fetch_user_segments - First observed
tikhub_get_api_v1_zhihu_web_fetch_video_list - First observed
tikhub_get_api_v1_zhihu_web_fetch_video_search_v3 - First observed
tikhub_post_api_v1_bilibili_huahuo_search_live_upper - First observed
tikhub_post_api_v1_bilibili_web_fetch_vip_video_playurl - First observed
tikhub_post_api_v1_douyin_app_v3_fetch_multi_video - First observed
tikhub_post_api_v1_douyin_app_v3_fetch_multi_video_high_quality - First observed
tikhub_post_api_v1_douyin_app_v3_fetch_multi_video_v2 - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_account_list - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_calendar_list - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_fan_lis - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_like_li - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_play_li - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_search - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_high_topic_l - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_hot_word_lis - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_low_fan_list - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_search_list - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_topic_list - First observed
tikhub_post_api_v1_douyin_billboard_fetch_hot_total_video_list - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_author_diagnosis - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_analysis_involve - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_analysis_item_pe - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_analysis_overvie - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_audience_others - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_audience_portrai - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_danmaku_analysis - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_list - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_list_download - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_overview_data - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_play_source - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_search_keyword - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_item_watch_trend - First observed
tikhub_post_api_v1_douyin_creator_v2_fetch_live_room_history_lis - First observed
tikhub_post_api_v1_douyin_douplus_calculate_cost - First observed
tikhub_post_api_v1_douyin_douplus_fetch_analyse_detail - First observed
tikhub_post_api_v1_douyin_douplus_fetch_analyse_graph - First observed
tikhub_post_api_v1_douyin_douplus_fetch_analyse_overview - First observed
tikhub_post_api_v1_douyin_douplus_fetch_promotable_item_list - First observed
tikhub_post_api_v1_douyin_douplus_fetch_promoted_accounts - First observed
tikhub_post_api_v1_douyin_douplus_fetch_sec_token - First observed
tikhub_post_api_v1_douyin_douplus_fetch_talent_categories - First observed
tikhub_post_api_v1_douyin_douplus_fetch_talents_by_category - First observed
tikhub_post_api_v1_douyin_douplus_fetch_user_posts - First observed
tikhub_post_api_v1_douyin_douplus_fetch_video_detail - First observed
tikhub_post_api_v1_douyin_douplus_fetch_video_ranking - First observed
tikhub_post_api_v1_douyin_douplus_search_live_room - First observed
tikhub_post_api_v1_douyin_douplus_search_user - First observed
tikhub_post_api_v1_douyin_douplus_search_user_v2 - First observed
tikhub_post_api_v1_douyin_douplus_search_video - First observed
tikhub_post_api_v1_douyin_index_fetch_brand_cycles - First observed
tikhub_post_api_v1_douyin_index_fetch_brand_hot_videos_time_scop - First observed
tikhub_post_api_v1_douyin_index_fetch_brand_initiative_rank_week - First observed
tikhub_post_api_v1_douyin_index_fetch_brand_lines - First observed
tikhub_post_api_v1_douyin_index_fetch_brand_radar_chart - First observed
tikhub_post_api_v1_douyin_index_fetch_brand_suggest - First observed
tikhub_post_api_v1_douyin_index_fetch_brand_valid_info - First observed
tikhub_post_api_v1_douyin_index_fetch_content_author_portrait - First observed
tikhub_post_api_v1_douyin_index_fetch_content_consume_trend - First observed
tikhub_post_api_v1_douyin_index_fetch_content_consumer_portrait - First observed
tikhub_post_api_v1_douyin_index_fetch_content_creative_duration - First observed
tikhub_post_api_v1_douyin_index_fetch_content_creative_keyword_i - First observed
tikhub_post_api_v1_douyin_index_fetch_content_creative_keywords - First observed
tikhub_post_api_v1_douyin_index_fetch_content_creative_topic - First observed
tikhub_post_api_v1_douyin_index_fetch_content_interact_trend - First observed
tikhub_post_api_v1_douyin_index_fetch_daren_compare_users_stable - First observed
tikhub_post_api_v1_douyin_index_fetch_daren_great_item_mile_info - First observed
tikhub_post_api_v1_douyin_index_fetch_daren_great_user_fans_info - First observed
tikhub_post_api_v1_douyin_index_fetch_daren_great_user_top_video - First observed
tikhub_post_api_v1_douyin_index_fetch_daren_similar_users - First observed
tikhub_post_api_v1_douyin_index_fetch_daren_sug_great_user_list - First observed
tikhub_post_api_v1_douyin_index_fetch_get_user_sub_word - First observed
tikhub_post_api_v1_douyin_index_fetch_item_analysis - First observed
tikhub_post_api_v1_douyin_index_fetch_item_base - First observed
tikhub_post_api_v1_douyin_index_fetch_item_index - First observed
tikhub_post_api_v1_douyin_index_fetch_item_index_interpret - First observed
tikhub_post_api_v1_douyin_index_fetch_item_query - First observed
tikhub_post_api_v1_douyin_index_fetch_item_sug - First observed
tikhub_post_api_v1_douyin_index_fetch_item_user_profile - First observed
tikhub_post_api_v1_douyin_index_fetch_keyword_valid_date - First observed
tikhub_post_api_v1_douyin_index_fetch_multi_keyword_hot_trend - First observed
tikhub_post_api_v1_douyin_index_fetch_multi_keyword_interpretati - First observed
tikhub_post_api_v1_douyin_index_fetch_portrait - First observed
tikhub_post_api_v1_douyin_index_fetch_relation_word - First observed
tikhub_post_api_v1_douyin_index_fetch_report_search - First observed
tikhub_post_api_v1_douyin_index_fetch_topic_query - First observed
tikhub_post_api_v1_douyin_index_fetch_topic_suggest - First observed
tikhub_post_api_v1_douyin_search_fetch_challenge_search_v1 - First observed
tikhub_post_api_v1_douyin_search_fetch_challenge_search_v2 - First observed
tikhub_post_api_v1_douyin_search_fetch_challenge_suggest - First observed
tikhub_post_api_v1_douyin_search_fetch_discuss_search - First observed
tikhub_post_api_v1_douyin_search_fetch_experience_search - First observed
tikhub_post_api_v1_douyin_search_fetch_general_search_v1 - First observed
tikhub_post_api_v1_douyin_search_fetch_general_search_v2 - First observed
tikhub_post_api_v1_douyin_search_fetch_general_search_v3 - First observed
tikhub_post_api_v1_douyin_search_fetch_image_search - First observed
tikhub_post_api_v1_douyin_search_fetch_image_search_v3 - First observed
tikhub_post_api_v1_douyin_search_fetch_live_search_v2 - First observed
tikhub_post_api_v1_douyin_search_fetch_multi_search - First observed
tikhub_post_api_v1_douyin_search_fetch_music_search - First observed
tikhub_post_api_v1_douyin_search_fetch_school_search - First observed
tikhub_post_api_v1_douyin_search_fetch_search_suggest - First observed
tikhub_post_api_v1_douyin_search_fetch_search_suggest_v2 - First observed
tikhub_post_api_v1_douyin_search_fetch_user_search - First observed
tikhub_post_api_v1_douyin_search_fetch_user_search_v2 - First observed
tikhub_post_api_v1_douyin_search_fetch_video_search_v1 - First observed
tikhub_post_api_v1_douyin_search_fetch_video_search_v2 - First observed
tikhub_post_api_v1_douyin_search_fetch_video_search_v3 - First observed
tikhub_post_api_v1_douyin_search_fetch_video_search_v4 - First observed
tikhub_post_api_v1_douyin_search_fetch_video_search_v5 - First observed
tikhub_post_api_v1_douyin_web_fetch_challenge_posts - First observed
tikhub_post_api_v1_douyin_web_fetch_home_feed - First observed
tikhub_post_api_v1_douyin_web_fetch_multi_video - First observed
tikhub_post_api_v1_douyin_web_fetch_multi_video_high_quality_pla - First observed
tikhub_post_api_v1_douyin_web_fetch_query_user - First observed
tikhub_post_api_v1_douyin_web_fetch_user_collection_videos - First observed
tikhub_post_api_v1_douyin_web_fetch_user_collects - First observed
tikhub_post_api_v1_douyin_web_fetch_user_like_videos - First observed
tikhub_post_api_v1_douyin_web_get_all_aweme_id - First observed
tikhub_post_api_v1_douyin_web_get_all_sec_user_id - First observed
tikhub_post_api_v1_douyin_web_get_all_webcast_id - First observed
tikhub_post_api_v1_douyin_xingtu_v2_get_ip_activity_list - First observed
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_comments - First observed
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_detail - First observed
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_th_analysis - First observed
tikhub_post_api_v1_douyin_xingtu_v2_get_item_report_trend - First observed
tikhub_post_api_v1_douyin_xingtu_v2_get_playlet_actor_rank_catal - First observed
tikhub_post_api_v1_douyin_xingtu_v2_get_recommend_for_star_autho - First observed
tikhub_post_api_v1_douyin_xingtu_v2_multi_get_author_info - First observed
tikhub_post_api_v1_douyin_xingtu_v2_multi_get_item_stats - First observed
tikhub_post_api_v1_lemon8_app_get_item_ids - First observed
tikhub_post_api_v1_lemon8_app_get_user_ids - First observed
tikhub_post_api_v1_tiktok_ads_get_ad_interactive_analysis - First observed
tikhub_post_api_v1_tiktok_ads_get_ad_keyframe_analysis - First observed
tikhub_post_api_v1_tiktok_ads_get_ad_percentile - First observed
tikhub_post_api_v1_tiktok_ads_get_ads_detail - First observed
tikhub_post_api_v1_tiktok_ads_get_configure_safety - First observed
tikhub_post_api_v1_tiktok_ads_get_creators_card - First observed
tikhub_post_api_v1_tiktok_ads_get_location_list - First observed
tikhub_post_api_v1_tiktok_ads_get_query_suggestions - First observed
tikhub_post_api_v1_tiktok_ads_get_recommended_ads - First observed
tikhub_post_api_v1_tiktok_ads_get_top_ads_filters - First observed
tikhub_post_api_v1_tiktok_ads_get_top_ads_spotlight - First observed
tikhub_post_api_v1_tiktok_ads_get_top_contents_item_detail - First observed
tikhub_post_api_v1_tiktok_ads_get_top_contents_list - First observed
tikhub_post_api_v1_tiktok_ads_get_trends_hashtag_detail - First observed
tikhub_post_api_v1_tiktok_ads_get_trends_hashtag_list - First observed
tikhub_post_api_v1_tiktok_ads_search_ads - First observed
tikhub_post_api_v1_tiktok_app_v3_check_live_room_online_batch - First observed
tikhub_post_api_v1_tiktok_app_v3_encrypt_decrypt_login_request - First observed
tikhub_post_api_v1_tiktok_app_v3_fetch_content_translate - First observed
tikhub_post_api_v1_tiktok_app_v3_fetch_home_feed - First observed
tikhub_post_api_v1_tiktok_app_v3_fetch_multi_video - First observed
tikhub_post_api_v1_tiktok_app_v3_fetch_multi_video_v2 - First observed
tikhub_post_api_v1_tiktok_app_v3_ttencrypt_algorithm - First observed
tikhub_post_api_v1_tiktok_creator_get_account_health_status - First observed
tikhub_post_api_v1_tiktok_creator_get_account_insights_overview - First observed
tikhub_post_api_v1_tiktok_creator_get_account_violation_list - First observed
tikhub_post_api_v1_tiktok_creator_get_creator_account_info - First observed
tikhub_post_api_v1_tiktok_creator_get_live_analytics_summary - First observed
tikhub_post_api_v1_tiktok_creator_get_product_analytics_list - First observed
tikhub_post_api_v1_tiktok_creator_get_product_related_videos - First observed
tikhub_post_api_v1_tiktok_creator_get_showcase_product_list - First observed
tikhub_post_api_v1_tiktok_creator_get_video_analytics_summary - First observed
tikhub_post_api_v1_tiktok_creator_get_video_associated_product_l - First observed
tikhub_post_api_v1_tiktok_creator_get_video_audience_stats - First observed
tikhub_post_api_v1_tiktok_creator_get_video_detailed_stats - First observed
tikhub_post_api_v1_tiktok_creator_get_video_list_analytics - First observed
tikhub_post_api_v1_tiktok_creator_get_video_to_product_stats - First observed
tikhub_post_api_v1_tiktok_web_fetch_gift_name_by_id - First observed
tikhub_post_api_v1_tiktok_web_fetch_gift_names_by_ids - First observed
tikhub_post_api_v1_tiktok_web_fetch_home_feed - First observed
tikhub_post_api_v1_tiktok_web_generate_x_mssdk_info - First observed
tikhub_post_api_v1_tiktok_web_generate_xbogus - First observed
tikhub_post_api_v1_tiktok_web_generate_xgnarly - First observed
tikhub_post_api_v1_tiktok_web_generate_xgnarly_and_xbogus - First observed
tikhub_post_api_v1_tiktok_web_get_all_aweme_id - First observed
tikhub_post_api_v1_tiktok_web_get_all_sec_user_id - First observed
tikhub_post_api_v1_tiktok_web_get_all_unique_id - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_channel_id_to_userna - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_channel_info - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_collection_videos - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_live_detail - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_live_history - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_search_channel_video - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_user_collections - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_user_profile - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_user_videos - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_video_comments - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_video_detail - First observed
tikhub_post_api_v1_wechat_channels_v2_fetch_video_share_url - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_account_articles - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_account_profile - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_account_services - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_article_ad - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_article_comments - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_article_detail - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_article_detail_h5 - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_article_stats - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_article_stats_h5 - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_comment_replies - First observed
tikhub_post_api_v1_wechat_mp_v2_fetch_related_articles - First observed
tikhub_post_api_v1_wechat_search_v2_fetch_search - First observed
tikhub_post_api_v1_wechat_search_v2_fetch_search_videos - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_core_data - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_data_summary - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_detail - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_fans_history - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_fans_profile - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_fans_summary - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_filter_options - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_list - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_notes - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_notes_rate - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_notes_v2 - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_blogger_similar - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_content_square - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_keyword_daily - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_keyword_related - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_keyword_stat - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_live_blogger_list - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_note_comments - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_note_components - First observed
tikhub_post_api_v1_xiaohongshu_pgy_get_note_detail - First observed
tikhub_post_api_v1_youtube_web_v2_get_video_streams_v3 - First observed
tikhub_post_api_v1_zhihu_web_fetch_scholar_search_v3 - First observed
tinyfish_get - First observed
tinyfish_post - First observed
tinyfish_post_v1_automation_run - First observed
treg_get_call_companyenrich_companies_autocomplete - First observed
treg_get_call_companyenrich_companies_enrich - First observed
treg_get_call_companyenrich_companies_get - First observed
treg_get_call_companyenrich_companies_workforce - First observed
treg_get_call_companyenrich_geo_country_get - First observed
treg_get_call_companyenrich_geo_regions - First observed
treg_get_call_companyenrich_industries_list - First observed
treg_get_call_companyenrich_keywords_autocomplete - First observed
treg_get_call_companyenrich_people_email - First observed
treg_get_call_companyenrich_people_get - First observed
treg_get_call_companyenrich_positions_autocomplete - First observed
treg_get_call_companyenrich_technologies_autocomplete - First observed
treg_get_call_enrichlayer_email_disposable_check - First observed
treg_get_call_predictleads_companies_connections - First observed
treg_get_call_predictleads_companies_financing_events - First observed
treg_get_call_predictleads_companies_news_events - First observed
treg_get_call_predictleads_companies_technology_detections - First observed
treg_post_call_companyenrich_companies_enrich_by_properties - First observed
treg_post_call_companyenrich_companies_search_count - First observed
treg_post_call_companyenrich_companies_similar_count - First observed
treg_post_call_companyenrich_geo_cities_search - First observed
treg_post_call_companyenrich_geo_countries_search - First observed
treg_post_call_companyenrich_geo_states_search - First observed
treg_post_call_crawl4ai_medium_posts_list - First observed
treg_post_call_crawl4ai_packages_package_info - First observed
treg_post_call_crawl4ai_remoteok_search_jobs - First observed
treg_post_call_crawl4ai_research_search_papers - First observed
treg_post_call_crawl4ai_shopify_store_products - First observed
treg_post_call_crawl4ai_stackoverflow_search_questions - First observed
treg_post_call_crawl4ai_steam_app_detail - First observed
treg_post_call_crawl4ai_web_feed_read - First observed
treg_post_call_crawl4ai_weworkremotely_search_jobs - First observed
treg_post_call_dropleads_people_search - First observed
treg_post_call_hlrlookup_people_phone_validate - First observed
treg_post_call_icypeas_people_search_count - First observed
treg_post_call_valyu_economics_indicators_search - First observed
treg_post_call_valyu_health_references_search - First observed
treg_post_call_valyu_health_trials_search - First observed
typesafe_post_v1_systemone - First observed
uniswap_get_v1_orders - First observed
uniswap_get_v1_plan_planid - First observed
uniswap_get_v1_supported_chains - First observed
uniswap_get_v1_swappable_tokens - First observed
uniswap_get_v1_swaps - First observed
uniswap_get_v1_tokens - First observed
uniswap_patch_v1_plan_planid - First observed
uniswap_post_lp_check_approval - First observed
uniswap_post_lp_claim_fees - First observed
uniswap_post_lp_create - First observed
uniswap_post_lp_create_classic - First observed
uniswap_post_lp_decrease - First observed
uniswap_post_lp_increase - First observed
uniswap_post_lp_pool_info - First observed
uniswap_post_v1_check_approval - First observed
uniswap_post_v1_order - First observed
uniswap_post_v1_permissions - First observed
uniswap_post_v1_plan - First observed
uniswap_post_v1_quote - First observed
uniswap_post_v1_swap - First observed
uniswap_post_v1_swap_5792 - First observed
uniswap_post_v1_swap_7702 - First observed
uniswap_post_v1_wallet_check_delegation - First observed
uniswap_post_v1_wallet_encode_7702 - First observed
wikimedia_get_analytics_pageviews_project_article_start_end - First observed
wikimedia_get_analytics_top_project_year_month_day - First observed
wikimedia_get_backlinks - First observed
wikimedia_get_category_members - First observed
wikimedia_get_commons_file - First observed
wikimedia_get_commons_search - First observed
wikimedia_get_coordinates - First observed
wikimedia_get_external_links - First observed
wikimedia_get_nearby - First observed
wikimedia_get_page_title - First observed
wikimedia_get_revision_from_compare_to - First observed
wikimedia_get_revisions - First observed
wikimedia_get_search - First observed
wikimedia_get_wikidata_entity - First observed
wikimedia_get_wikidata_entity_search - First observed
wikimedia_get_wikidata_id - First observed
wikimedia_get_zh_article_en - First observed
wikimedia_get_zh_article_intro - First observed
wikimedia_get_zh_search - First observed
wikivoyage_get_guide_title - First observed
wikivoyage_get_search - First observed
wikivoyage_get_zh_guide_title - First observed
wikivoyage_get_zh_search - First observed
youcom_post_v1_answer - First observed
youcom_post_v1_search - First observed
yuandian_get_open_rh_case_details - First observed
yuandian_get_open_rh_company_detail - First observed
yuandian_get_open_rh_company_info - First observed
yuandian_get_open_rh_enterpriseabnormaloperation - First observed
yuandian_get_open_rh_enterpriseaggregationsummary - First observed
yuandian_get_open_rh_enterpriseannualreport - First observed
yuandian_get_open_rh_enterprisebaseinfo - First observed
yuandian_get_open_rh_enterprisebrand - First observed
yuandian_get_open_rh_enterprisechangeinfo - First observed
yuandian_get_open_rh_enterprisecorporatetax - First observed
yuandian_get_open_rh_enterprisecourtnotice - First observed
yuandian_get_open_rh_enterprisecourtsessionnotice - First observed
yuandian_get_open_rh_enterpriseexecutedperson - First observed
yuandian_get_open_rh_enterpriseexecutions - First observed
yuandian_get_open_rh_enterprisefrozenequity - First observed
yuandian_get_open_rh_enterpriseguaranty - First observed
yuandian_get_open_rh_enterpriseicp - First observed
yuandian_get_open_rh_enterpriseoutinvest - First observed
yuandian_get_open_rh_enterprisepatent - First observed
yuandian_get_open_rh_enterprisepledge - First observed
yuandian_get_open_rh_enterprisepunishment - First observed
yuandian_get_open_rh_enterprisesearch - First observed
yuandian_get_open_rh_enterpriseseriousillegal - First observed
yuandian_get_open_rh_enterprisesoftright - First observed
yuandian_get_open_rh_enterpriseworksright - First observed
yuandian_get_open_rh_enterprisewritagg - First observed
yuandian_get_open_rh_enterprisewritlist - First observed
yuandian_post_open_case_vector_search - First observed
yuandian_post_open_law_vector_search - First observed
yuandian_post_open_law_vector_zq_search - First observed
yuandian_post_open_rh_fg_detail - First observed
yuandian_post_open_rh_fg_search - First observed
yuandian_post_open_rh_fg_zq_search - First observed
yuandian_post_open_rh_ft_detail - First observed
yuandian_post_open_rh_ft_search - First observed
yuandian_post_open_rh_ft_zq_search - First observed
yuandian_post_open_rh_ptal_search - First observed
yuandian_post_open_rh_qwal_search - First observed
yuandian_post_open_rh_ssgsgg_search - First observed
yuandian_post_open_rh_zqcfws_search
Related MCP Connectors
One key and one balance for 2,500+ data APIs from 90+ providers. Your AI agent pays per call.
AI service marketplace — agents discover, call, and pay for API services automatically.
Pay-per-use API marketplace for AI agents: LLMs, image, TTS, search. Free trial, x402.
Verified, pay-per-use API tools for AI agents through one authenticated connection.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceProvides AI agents access to over 200 AI models and 10 service categories via a unified, metered API with transparent per-call pricing.9 npmMIT

UCM MCP Serverofficial
FlicenseNot gradedqualityDmaintenanceEnables AI agents to autonomously discover and call a marketplace of 100+ APIs, including web search, image generation, and more, with automatic payments and refunds.-- AlicenseNot gradedqualityDmaintenanceEnables autonomous agents to discover, price, and call hosted AI models and tools, and manage payments via a self-serve API marketplace.1MIT
- FlicenseNot gradedqualityCmaintenancePay-per-use tool marketplace for AI agents. Search, price-check, and call APIs via MCP.-
Glama MCP Gateway
Add one secure layer between your agents and this server.