\n
Example Domain
\n"}}}}}},"/text":{"get":{"summary":"Page text by URL (Markdown)","description":"Converts a webpage to clean Markdown (\"URL to Markdown\") - boilerplate is stripped and the document structure (headings, lists, links) is preserved; tables come through as plain text, one paragraph per cell. Can be used to feed data to LLM models and RAG pipelines. text_format=plain (default) returns the raw Markdown; \"json\" and \"xml\" wrap the same Markdown content with the page title and description. Proxies and Chromium JavaScript rendering are used for page retrieval and processing. Returns JSON on error.","operationId":"getText","tags":["Text"],"parameters":[{"$ref":"#/components/parameters/text_format"},{"$ref":"#/components/parameters/return_links"},{"$ref":"#/components/parameters/url"},{"$ref":"#/components/parameters/headers"},{"$ref":"#/components/parameters/timeout"},{"$ref":"#/components/parameters/js"},{"$ref":"#/components/parameters/js_timeout"},{"$ref":"#/components/parameters/wait_for"},{"$ref":"#/components/parameters/proxy"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/custom_proxy"},{"$ref":"#/components/parameters/device"},{"$ref":"#/components/parameters/error_on_404"},{"$ref":"#/components/parameters/error_on_redirect"},{"$ref":"#/components/parameters/js_script"}],"responses":{"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"504":{"$ref":"#/components/responses/504"},"200":{"description":"Success","headers":{"Wsai-Request-Id":{"$ref":"#/components/headers/Wsai-Request-Id"}},"content":{"text/html":{"schema":{"type":"string"},"example":"Some content"},"text/xml":{"schema":{"type":"string"},"example":"
Some title\n
Some description\n
Some content"},"application/json":{"schema":{"type":"string"},"example":"{\"title\":\"Some title\",\"description\":\"Some description\",\"content\":\"Some content\"}"}}}}}},"/selected":{"get":{"summary":"HTML of a selected page area by URL and CSS selector","description":"Returns HTML of a selected page area by URL and CSS selector. Useful if you don't want to do the HTML parsing on your side.","operationId":"getSelected","tags":["Selected HTML"],"parameters":[{"in":"query","name":"selector","description":"CSS selector of the page area to return. The inner HTML of the first matching element is returned; if nothing matches, the request fails with a 400 \"Element not found\".","example":"h1","schema":{"type":"string"}},{"$ref":"#/components/parameters/url"},{"$ref":"#/components/parameters/headers"},{"$ref":"#/components/parameters/timeout"},{"$ref":"#/components/parameters/js"},{"$ref":"#/components/parameters/js_timeout"},{"$ref":"#/components/parameters/wait_for"},{"$ref":"#/components/parameters/proxy"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/custom_proxy"},{"$ref":"#/components/parameters/device"},{"$ref":"#/components/parameters/error_on_404"},{"$ref":"#/components/parameters/error_on_redirect"},{"$ref":"#/components/parameters/js_script"},{"$ref":"#/components/parameters/format"}],"responses":{"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"504":{"$ref":"#/components/responses/504"},"200":{"description":"Success","headers":{"Wsai-Request-Id":{"$ref":"#/components/headers/Wsai-Request-Id"}},"content":{"text/html":{"schema":{"type":"string"},"example":"
More information..."}}}}}},"/selected-multiple":{"get":{"summary":"HTML of multiple page areas by URL and CSS selectors","description":"Returns HTML of multiple page areas by URL and CSS selectors. Useful if you don't want to do the HTML parsing on your side.","operationId":"getSelectedMultiple","tags":["Selected HTML"],"parameters":[{"in":"query","name":"selectors","description":"Multiple CSS selectors. Repeat the parameter once per selector (selectors=h1&selectors=p); bracketed forms such as selectors[]=h1 are not recognized and return empty results.","example":["h1"],"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"$ref":"#/components/parameters/url"},{"$ref":"#/components/parameters/headers"},{"$ref":"#/components/parameters/timeout"},{"$ref":"#/components/parameters/js"},{"$ref":"#/components/parameters/js_timeout"},{"$ref":"#/components/parameters/wait_for"},{"$ref":"#/components/parameters/proxy"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/custom_proxy"},{"$ref":"#/components/parameters/device"},{"$ref":"#/components/parameters/error_on_404"},{"$ref":"#/components/parameters/error_on_redirect"},{"$ref":"#/components/parameters/js_script"}],"responses":{"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"504":{"$ref":"#/components/responses/504"},"200":{"description":"Success","headers":{"Wsai-Request-Id":{"$ref":"#/components/headers/Wsai-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectedAreas"},"example":[["Example Domain"],["This domain is for use in documentation examples without needing permission. Avoid use in operations.","
Learn more"]]}}}}}},"/serp":{"get":{"summary":"Search engine results (SERP) by query","description":"Returns parsed search engine results for a query. The engine is selected with the `engine` parameter (currently `google`, the default). Unlike the page endpoints this is query-shaped, not URL-shaped: pass `q` (the search query) instead of `url`, and WebScraping.AI handles proxy routing and parsing. The response uses the common SERP API naming: `organic_results` items carry `position` (1-based within the page), `title`, `link`, `domain`, `displayed_link`, `snippet` and `date`; `search_information` reports the displayed query, a spelling fix and whether the page had results; `related_searches` and `pagination` complete the page. Flat pricing of 15 credits per search; failed searches are not charged. Response is JSON.\n","operationId":"getSerp","tags":["SERP"],"parameters":[{"in":"query","name":"q","required":true,"description":"Search query.","example":"coffee machines","schema":{"type":"string"}},{"in":"query","name":"engine","description":"Search engine to query.","schema":{"type":"string","enum":["google"],"default":"google"}},{"in":"query","name":"gl","description":"Two-letter country code for geolocation of the search (Google `gl` parameter).","example":"us","schema":{"type":"string","default":"us"}},{"in":"query","name":"hl","description":"Two-letter language code for the results (Google `hl` parameter).","example":"en","schema":{"type":"string","default":"en"}},{"in":"query","name":"page","description":"Results page number (10 results per page), from 1 to 100. Any other value (0, a fraction, a non-number, or above 100) is rejected with a 400 before billing.","example":1,"schema":{"type":"integer","minimum":1,"maximum":100,"default":1}}],"responses":{"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"504":{"$ref":"#/components/responses/504"},"200":{"description":"Success","headers":{"Wsai-Request-Id":{"$ref":"#/components/headers/Wsai-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerpResult"},"example":{"search_parameters":{"engine":"google","q":"coffee machines","gl":"us","hl":"en","page":1},"search_information":{"query_displayed":"coffee machines","organic_results_state":"Results for exact spelling"},"organic_results":[{"position":1,"title":"Best Coffee Machines of 2026","link":"https://www.example.com/best-coffee-machines","domain":"example.com","displayed_link":"www.example.com › Reviews › Coffee Machines","snippet":"We tested 20 coffee machines to find the best ones for every budget...","date":"Apr 13, 2026"},{"position":2,"title":"Coffee Machines | Example Store","link":"https://shop.example.org/coffee-machines","domain":"shop.example.org","displayed_link":"shop.example.org › coffee-machines"}],"related_searches":[{"query":"best espresso machine"}],"pagination":{"current":1,"next":2}}}}}}}},"/data":{"get":{"summary":"Structured data for a page on a supported site","description":"Returns structured JSON for a public page on a supported site, for example a YouTube video, a TikTok profile, an X post, a LinkedIn company, an Instagram reel or a Reddit thread. Pass the page's normal URL; the site (`provider`) and page kind (`type`) are detected from it, and WebScraping.AI handles fetching, proxies and parsing. The set of supported sites and page types grows on the server, so clients should not validate URLs themselves: an unsupported URL or page type is rejected with a 400 (not charged) whose message lists what is supported. The shape of `data` depends on `provider` and `type`; fields use snake_case, and fields a page doesn't expose are null (some flags come back false, and lists come back empty). Pricing is 15 credits per request (50 for Reddit), including pages that parse empty (`parse_status` `parse_failed`) or no longer exist (`not_found`); requests that fail to fetch are not charged. Response is JSON.\n","operationId":"getData","tags":["Structured Data"],"parameters":[{"in":"query","name":"url","required":true,"description":"URL of a page on a supported site.","example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ","schema":{"type":"string"}},{"in":"query","name":"country","description":"Two-letter country code of the proxy used to fetch the page (`us` by default). Must be one of the API's proxy countries (see the `country` parameter of the page endpoints); other values are rejected with a 400.","example":"us","schema":{"type":"string","default":"us"}},{"in":"query","name":"transcript","description":"YouTube videos only. Also fetch the video's transcript into `data.transcript` (null when no matching captions are available). If the transcript fetch itself fails, the whole request fails with a 500 and is not charged.","schema":{"type":"boolean","default":false}},{"in":"query","name":"transcript_language","description":"YouTube videos only, with `transcript=true`. Caption language to pick, e.g. `en` or `de`. Without it, English is preferred, then the first available track. If the video has no captions in that language, `data.transcript` is null.","example":"en","schema":{"type":"string"}}],"responses":{"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"504":{"$ref":"#/components/responses/504"},"200":{"description":"Success","headers":{"Wsai-Request-Id":{"$ref":"#/components/headers/Wsai-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResult"},"example":{"request_parameters":{"url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ","provider":"youtube","type":"video"},"parse_status":"ok","data":{"video_id":"dQw4w9WgXcQ","title":"Rick Astley - Never Gonna Give You Up (Official Video) (4K Remaster)","link":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}}}}}}}},"/account":{"get":{"summary":"Information about your account calls quota","description":"Returns information about your account, including the remaining API credits quota, the next billing cycle start time, and the remaining concurrent requests. The response is in JSON format.","operationId":"account","tags":["Account"],"responses":{"403":{"$ref":"#/components/responses/403"},"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"},"example":{"remaining_api_calls":200000,"remaining_monthly_credits":200000,"remaining_payg_credits":100000,"remaining_total_credits":300000,"resets_at":1617073667,"remaining_concurrency":100}}}}}}}},"security":[{"api_key":[]}],"servers":[{"url":"https://api.webscraping.ai"}],"components":{"headers":{"Wsai-Request-Id":{"description":"Unique ID of this API request. Include it when contacting support about a specific request.","schema":{"type":"string","format":"uuid"},"example":"5b2a45c2-973f-443d-857c-6c21b05f35d5"}},"securitySchemes":{"api_key":{"type":"apiKey","name":"api_key","in":"query"}},"responses":{"400":{"description":"Parameters validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"message":"Invalid CSS selector"}}}},"402":{"description":"Out of API credits — upgrade your plan or top up your pay-as-you-go balance on https://webscraping.ai/dashboard/billing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"message":"Your requests quota is exceeded. Please upgrade your plan or top up your PAYG balance on https://webscraping.ai/dashboard/billing, or wait until 2026-09-01."}}}},"403":{"description":"Wrong or missing API key. Get a key at https://webscraping.ai/dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"message":"Wrong API key."}}}},"429":{"description":"Too many concurrent requests for your plan. Wait for a running request to finish and retry, or upgrade for a higher limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"message":"Too many concurrent requests, wait or upgrade your plan. Your current limit is 2."}}}},"500":{"description":"The target page could not be scraped (blocked, anti-bot challenge, non-2xx status, DNS failure) or an unexpected error occurred. Failed requests are not billed (the one exception is a redirect returned because of `error_on_redirect=true`, which is a successful outcome you asked for).\nFailures on the scraping endpoints (/html, /text, /selected, /selected-multiple, /ai/*) carry a machine-readable `error_code` and, when a better configuration exists, a `next_step` with the parameters to retry with and their credit cost. /serp and /data have their own error envelopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"message":"The target website returned HTTP 403 (Forbidden) through a datacenter proxy: it is blocking this IP pool (anti-bot protection). Retry with proxy=residential (10 credits per request). Failed requests are not billed.","error_code":"target_blocked","status_code":403,"status_message":"Forbidden","body":"Access denied","request_parameters":{"proxy":"datacenter","js":false},"next_step":{"params":{"proxy":"residential"},"cost":10,"message":"Retry with proxy=residential (10 credits per request)."}}}}},"504":{"description":"Timeout error, try increasing timeout parameter value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"message":"Timeout error, try increasing timeout parameter value","error_code":"timeout"}}}}},"parameters":{"url":{"in":"query","name":"url","description":"URL of the target page.","required":true,"example":"https://example.com","schema":{"type":"string"}},"headers":{"in":"query","name":"headers","description":"HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&headers[One]=value1&headers[Another]=value2) or as a JSON encoded object (...&headers={\"One\": \"value1\", \"Another\": \"value2\"}).","example":{"Cookie":"session=some_id"},"schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true},"timeout":{"in":"query","name":"timeout","description":"Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 25000; larger values are capped at 25000).","example":10000,"schema":{"type":"integer","default":10000,"minimum":1,"maximum":25000}},"js":{"in":"query","name":"js","description":"Execute on-page JavaScript using a headless browser (true by default).","example":true,"schema":{"type":"boolean","default":true}},"js_timeout":{"in":"query","name":"js_timeout","description":"Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page.","example":2000,"schema":{"type":"integer","default":2000,"minimum":1,"maximum":20000}},"wait_for":{"in":"query","name":"wait_for","description":"CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout. If the element doesn't appear within the request timeout, the request fails with a 500 error naming the selector and including the target page's HTTP status code and a preview of the page body.","example":"#content","schema":{"type":"string"}},"proxy":{"in":"query","name":"proxy","description":"Type of proxy. Use `residential` if your site restricts traffic from datacenters, or `stealth` for the most heavily protected sites with advanced anti-bot detection (`datacenter` by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details.\n\n`auto` walks the tiers cheapest-first inside one request (datacenter, then residential, then stealth; anti-bot challenge pages skip straight to stealth) and bills only the tier that succeeded. Failed attempts are free. The API remembers, per domain, the cheapest tier that worked and starts there for 30 days, so repeat requests to a protected site do not re-pay the failed rungs in latency. Cannot be combined with `custom_proxy`.\n","example":"datacenter","schema":{"type":"string","default":"datacenter","enum":["datacenter","residential","stealth","auto"]}},"country":{"in":"query","name":"country","description":"Country of the proxy to use (US by default).","example":"us","schema":{"type":"string","default":"us","enum":["us","gb","de","it","fr","ca","es","ru","jp","kr","in","hk","tr"]}},"custom_proxy":{"in":"query","name":"custom_proxy","description":"Your own proxy URL to use instead of our built-in proxy pool in \"http://user:password@host:port\" format (
Decodo, formerly Smartproxy, for example).","example":"http://user:password@proxy.example.com:8080","schema":{"type":"string"}},"device":{"in":"query","name":"device","description":"Type of device emulation.","example":"desktop","schema":{"type":"string","default":"desktop","enum":["desktop","mobile","tablet"]}},"error_on_404":{"in":"query","name":"error_on_404","description":"Return error on 404 HTTP status on the target page (false by default).","example":false,"schema":{"type":"boolean","default":false}},"error_on_redirect":{"in":"query","name":"error_on_redirect","description":"Return error on redirect on the target page (false by default).","example":false,"schema":{"type":"boolean","default":false}},"js_script":{"in":"query","name":"js_script","description":"Custom JavaScript code to execute on the target page. It is evaluated as a script whose result is the value of its last expression (a top-level `return` is a syntax error), and it is only run by /html; the other endpoints accept the parameter but ignore it.","example":"document.querySelector('button').click();","schema":{"type":"string"}},"return_script_result":{"in":"query","name":"return_script_result","description":"Return result of the custom JavaScript code (js_script parameter) execution on the target page (false by default, page HTML will be returned).","example":false,"schema":{"type":"boolean","default":false}},"text_format":{"in":"query","name":"text_format","description":"Format of the text response (plain by default). \"plain\" will return the page body content as Markdown. \"json\" and \"xml\" will return a json/xml with \"title\", \"description\" and \"content\" (Markdown) keys.","example":"plain","schema":{"type":"string","default":"plain","enum":["plain","xml","json"]}},"return_links":{"in":"query","name":"return_links","description":"[Works only with text_format=json] Return links from the page body text (false by default). Useful for building web crawlers.","example":false,"schema":{"type":"boolean","default":false}},"question":{"in":"query","name":"question","description":"Question or instructions to ask the LLM model about the target page.","example":"What is the summary of this page content?","schema":{"type":"string"}},"format":{"in":"query","name":"format","description":"Format of the response (text by default). \"text\" returns the plain text/HTML response. \"json\" wraps it in a JSON object with a `result` key, for tools such as Zapier that only accept JSON.","example":"text","schema":{"type":"string","default":"text","enum":["json","text"]}}},"schemas":{"Error":{"title":"Generic error","type":"object","properties":{"message":{"type":"string","description":"Error description"},"status_code":{"type":"integer","description":"Target page response HTTP status code (403, 500, etc)"},"status_message":{"type":"string","description":"Target page response HTTP status message"},"body":{"type":"string","description":"Target page response body preview (first 500 characters), when the target returned one"},"error_code":{"type":"string","description":"Machine-readable failure class, present on 500 and 504 responses from the scraping endpoints (/html, /text, /selected, /selected-multiple, /ai/*).\n`target_blocked` (403/429/503/999 from the target), `target_challenge` (anti-bot challenge page served as content),\n`target_error` (other non-2xx status), `target_redirect` (redirect with `error_on_redirect=true`),\n`target_unreachable` (DNS failure or connection closed during TLS), `invalid_url`, `forbidden_target`,\n`custom_proxy_error` (your custom_proxy returned 407), `wait_for_timeout`, `response_too_large`, `timeout` (504), `internal_error`.\n","enum":["target_blocked","target_challenge","target_error","target_redirect","target_unreachable","invalid_url","forbidden_target","custom_proxy_error","wait_for_timeout","response_too_large","timeout","internal_error"]},"request_parameters":{"type":"object","description":"The configuration the failed request ran with. Present on target-side errors (blocked, challenge, non-2xx, connection closed, wait_for), not on request-validation errors.","properties":{"proxy":{"type":"string","description":"Proxy tier used. For `proxy=auto` this is the tier the walk ended on.","enum":["datacenter","residential","stealth","custom","dedicated"]},"js":{"type":"boolean","description":"Whether JavaScript rendering was enabled"},"auto":{"type":"boolean","description":"Present (true) when the request used `proxy=auto`."},"tiers_tried":{"type":"array","description":"For `proxy=auto`, the tiers walked in order before giving up.","items":{"type":"string","enum":["datacenter","residential","stealth"]}}}},"next_step":{"type":"object","description":"The next configuration worth trying, with its price on current plans. Absent when the request already used the strongest configuration (stealth or a dedicated route), when a retry would not help (bad URL, site's own 4xx), or for Google search URLs (use /serp instead).","properties":{"params":{"type":"object","description":"Parameters to add to (or change on) the retried request","additionalProperties":{"type":"string"}},"remove":{"type":"array","description":"Parameters to drop from the retried request (present when the failed request used custom_proxy, which otherwise overrides any proxy setting)","items":{"type":"string"}},"cost":{"type":"integer","description":"Credits per request with those parameters on current plans"},"message":{"type":"string","description":"Human-readable version of the suggestion"}}}}},"SelectedAreas":{"title":"HTML for selected page areas","type":"array","description":"One array per requested selector, in request order, holding the inner HTML of every element that matches it (empty when nothing matches).","items":{"type":"array","items":{"type":"string"}}},"SerpResult":{"title":"Search engine results","type":"object","properties":{"search_parameters":{"type":"object","description":"The normalized parameters the search was run with.","properties":{"engine":{"type":"string","example":"google"},"q":{"type":"string","example":"coffee machines"},"gl":{"type":"string","example":"us"},"hl":{"type":"string","example":"en"},"page":{"type":"integer","example":1}}},"search_information":{"type":"object","description":"What Google reported about the search itself.","properties":{"query_displayed":{"type":"string","description":"The query the results are for. Equals `q` unless Google applied a spelling fix.","example":"coffee machines"},"organic_results_state":{"type":"string","description":"`Results for exact spelling` when organic results are present for `q`; `Empty showing fixed spelling results` when Google auto-corrected the query and the results are for the corrected one (see `showing_results_for`); `Fully empty` when the page had no organic results (a real empty result page is a successful, billed search).\n","enum":["Results for exact spelling","Empty showing fixed spelling results","Fully empty"],"example":"Results for exact spelling"},"showing_results_for":{"type":"string","description":"The auto-corrected query, present only when Google applied a spelling fix.","example":"coffee machines"}}},"organic_results":{"type":"array","description":"Organic (non-ad) search results, in rank order.","items":{"type":"object","properties":{"position":{"type":"integer","description":"Rank of the result within this page, starting at 1 on every page (compute `(page - 1) * 10 + position` for an absolute rank).","example":1},"title":{"type":"string","example":"Best Coffee Machines of 2026"},"link":{"type":"string","example":"https://www.example.com/best-coffee-machines"},"domain":{"type":"string","description":"Hostname of `link` without a leading `www.`.","example":"example.com"},"displayed_link":{"type":"string","description":"The breadcrumb-style URL Google displays under the title. Falls back to `domain` when Google shows none.","example":"www.example.com › Reviews › Coffee Machines"},"snippet":{"type":"string","description":"Result description snippet, when Google shows one.","example":"We tested 20 coffee machines to find the best ones for every budget..."},"date":{"type":"string","description":"The date Google displays next to the snippet, as shown (absolute or relative), when present.","example":"Apr 13, 2026"}}}},"related_searches":{"type":"array","description":"Google's \"Related searches\" suggestions for this query. Omitted when the page shows none.","items":{"type":"object","properties":{"query":{"type":"string","example":"best espresso machine"}}}},"pagination":{"type":"object","properties":{"current":{"type":"integer","example":1},"next":{"type":"integer","description":"The next page number. Omitted when Google offers no further page.","example":2}}}}},"DataResult":{"title":"Structured page data","type":"object","properties":{"request_parameters":{"type":"object","description":"The URL as requested and how it was classified.","properties":{"url":{"type":"string","example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"},"provider":{"type":"string","description":"The detected site, e.g. `youtube`, `tiktok`, `twitter`, `linkedin`, `instagram` or `reddit`. New sites are added over time, so treat this as an open set.","example":"youtube"},"type":{"type":"string","description":"The detected page kind within the site, e.g. `video`, `channel`, `playlist`, `profile`, `post`, `company` or `job`. Also an open set.","example":"video"}}},"parse_status":{"type":"string","description":"`ok` when the page was parsed; `parse_failed` when the page was fetched but couldn't be parsed (`data` may be null or partial); `not_found` when the page doesn't exist. All three are successful, charged requests. Treat unknown values as an open set.\n","example":"ok"},"data":{"type":["object","null"],"description":"The page's fields. The shape depends on `provider` and `type`.","additionalProperties":true,"example":{"video_id":"dQw4w9WgXcQ","title":"Rick Astley - Never Gonna Give You Up (Official Video)","link":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}}}},"Account":{"title":"Account limits info","type":"object","properties":{"email":{"type":"string","description":"Your account email"},"remaining_api_calls":{"type":"integer","deprecated":true,"description":"Deprecated alias of remaining_monthly_credits, kept for backward compatibility"},"remaining_monthly_credits":{"type":"integer","description":"Remaining monthly API credits on the subscription plan (does not include pay-as-you-go credits)"},"remaining_payg_credits":{"type":"integer","description":"Remaining pay-as-you-go credits, consumed after the monthly quota is exhausted (valid for 12 months after the last top-up)"},"remaining_total_credits":{"type":"integer","description":"Total remaining API credits (monthly + pay-as-you-go)"},"resets_at":{"type":"integer","description":"Next billing cycle start time (UNIX timestamp)"},"remaining_concurrency":{"type":"integer","description":"Remaining concurrent requests"}}}}}}